-
Notifications
You must be signed in to change notification settings - Fork 5
Expand file tree
/
Copy pathREADME.txt
More file actions
194 lines (142 loc) · 8.08 KB
/
README.txt
File metadata and controls
194 lines (142 loc) · 8.08 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
DAISY Pipeline 2 - 1.15.3 - October 23, 2025
==============================================================================
1. What is the DAISY Pipeline 2 ?
2. Contents of the package
3. Release notes
4. Prerequisites
5. Getting started
6. Documentation
7. Known limitations
8. Contact
1. What is the DAISY Pipeline 2 ?
------------------------------------------------------------------------------
The DAISY Pipeline 2 is an ongoing project to develop a next generation
framework for automated production of accessible materials for people with
print disabilities. It is the follow-up and total redesign of the original
DAISY Pipeline 1 project.
For more information see:
- the project page: http://www.daisy.org/pipeline2
- the development site: https://github.com/daisy
2. Contents of the package
------------------------------------------------------------------------------
The package includes:
- a modular runtime framework for the Pipeline 2 modules
- a graphical user interface (GUI) to execute pipeline scripts
- a command line interface (CLI) to execute pipeline scripts
- dedicated launchers for the Pipeline 2 Web Service, in the "bin" directory
- a set of processing modules providing the following conversions:
* daisy202-to-epub3 Transforms a DAISY 2.02 publication into an EPUB 3
publication.
* daisy202-validator Validates a DAISY 2.02 fileset.
* daisy3-to-epub3 Transforms a DAISY 3 publication into an EPUB 3
publication.
* dtbook-to-daisy3 Converts multiple dtbooks to daisy 3 format
* dtbook-to-epub3 Converts multiple dtbooks to EPUB 3 format
* dtbook-to-html Transforms DTBook XML into HTML.
* dtbook-to-odt Transforms DTBook XML into ODT (OpenDocument Text).
* dtbook-to-pef Transforms a DTBook (DAISY 3 XML) document into
a PEF.
* dtbook-to-rtf Transforms DTBook XML into RTF (Rich Text Format).
* dtbook-to-zedai Transforms DTBook XML into ZedAI XML.
* dtbook-validator Validates DTBook documents. Supports inclusion of
MathML.
* epub3-to-daisy202 Transforms an EPUB 3 publication into DAISY 2.02.
* epub3-to-epub3 Transforms an EPUB 3 publication into an EPUB 3
publication with a braille rendition.
* epub3-to-pef Transforms a EPUB 3 publication into a PEF.
* html-to-epub3 Transforms (X)HTML documents into an EPUB 3
publication.
* html-to-pef Transforms a HTML document into a PEF.
* nimas-fileset-validator Validate a NIMAS Fileset. Supports inclusion of
MathML.
* zedai-to-epub3 Transforms a ZedAI (DAISY 4 XML) document into an
EPUB 3 publication.
* zedai-to-html Transforms ZedAI XML (ANSI/NISO Z39.98-2012
Authoring and Interchange) into HTML.
* zedai-to-pef Transforms a ZedAI (DAISY 4 XML) document into a
PEF.
3. Release Notes
------------------------------------------------------------------------------
The package includes the 1.15.3 version of the project.
See the release notes on this page:
https://github.com/daisy/pipeline-assembly/blob/master/NEWS.md#changes-in-release-v1153
4. Prerequisites
------------------------------------------------------------------------------
Modules already include their dependent libraries and only require a recent
Java environment (Java SE 11 or later).
To get the latest version of Java, go to http://www.java.com/
5. Getting Started
------------------------------------------------------------------------------
### Command line tool ###
1. get the short help by running the launcher script 'dp2' on
Mac/Linux or 'dp2.exe' on Windows from the "cli" directory
2. run 'dp2 help a-script-name' to get the detailed description of a script
4. execute a job with the 'dp2 a-script-name' subcommand and specify the
required options (as given with the 'dp2 help a-script-name' command)
For instance:
> cli\dp2.exe dtbook-to-zedai --source samples\dtbook\hauy_valid.xml
--output "C:\Users\John Doe\Desktop\out"
will run the DTBook to ZedAI converter on Windows and will output the result
in the "out" directory on the desktop of the user named "John Doe".
### RESTful Web Service ###
1. start the web service by running 'bin/pipeline' on Mac/Linux or
'bin\pipeline.bat' on Windows
2. the web service is available on http://localhost:8181/ws/
3. For example, get the list of scripts by issuing a GET request on
http://localhost:8181/ws/scripts
6. Documentation
------------------------------------------------------------------------------
Usage dp2 [GLOBAL_OPTIONS] command [COMMAND_OPTIONS] [PARAMS]
Script commands:
daisy202-to-epub3 Transforms a DAISY 2.02 publication into an EPUB3
publication.
daisy202-validator Validates a DAISY 2.02 fileset.
daisy3-to-epub3 Transforms a DAISY 3 publication into an EPUB 3
publication.
dtbook-to-daisy3 Converts multiple dtbooks to daisy 3 format
dtbook-to-epub3 Converts multiple dtbooks to epub3 format
dtbook-to-html Transforms DTBook XML into HTML.
dtbook-to-pef Transforms a DTBook (DAISY 3 XML) document into a
PEF.
dtbook-to-zedai Transforms DTBook XML into ZedAI XML.
dtbook-validator Validates DTBook documents. Supports inclusion of
MathML.
epub3-to-daisy202 Transforms an EPUB3 publication into DAISY 2.02.
epub3-to-pef Transforms a EPUB 3 publication into a PEF.
html-to-epub3 Transforms (X)HTML documents into an EPUB 3
publication.
html-to-pef Transforms a HTML document into a PEF.
nimas-fileset-validator Validate a NIMAS Fileset. Supports inclusion of
MathML.
zedai-to-epub3 Transforms a ZedAI (DAISY 4 XML) document into an
EPUB 3 publication.
zedai-to-html Transforms ZedAI XML (ANSI/NISO Z39.98-2012 Authoring
and Interchange) into HTML.
zedai-to-pef Transforms a ZedAI (DAISY 4 XML) document into a PEF.
General commands:
status Returns the status of the job with id JOB_ID
delete Removes a job from the pipeline
results Stores the results from a job
jobs Returns the list of jobs present in the server
log Stores the results from a job
queue Shows the execution queue and the job's priorities.
moveup Moves the job up the execution queue
movedown Moves the job down the execution queue
clean Removes the jobs with an ERROR status
halt Stops the webservice
version Prints the version and authentication information
List of global options: dp2 help -g
List of admin commands: dp2 help -a
Detailed help for a single command: dp2 help COMMAND
A complete user guide is in the works and will be available soon.
7. Known limitations
------------------------------------------------------------------------------
Please refer to the issue tracker:
https://github.com/daisy/pipeline
8. Contact
------------------------------------------------------------------------------
If you want to join the effort and contribute to the Pipeline 2 project, feel
free to join us on the developers discussion list hosted on Google Groups:
http://groups.google.com/group/daisy-pipeline-dev
or contact the project lead (Romain Deltour) via email at
`rdeltour (at) gmail (dot) com`