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: README.md
+36-19Lines changed: 36 additions & 19 deletions
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,9 @@
1
-
1
+
<!DOCTYPE html>
2
+
<html>
3
+
<head>
4
+
<title>OASIS TC Open Repository: dita-rng-converter</title>
5
+
</head>
6
+
<body>
2
7
<div>
3
8
<h1>README</h1>
4
9
@@ -20,7 +25,14 @@
20
25
21
26
<p>Statement of Purpose for this OASIS TC Open Repository (dita-rng-converter) as <ahref="https://lists.oasis-open.org/archives/dita/201601/msg00040.html">proposed</a> and <ahref="https://www.oasis-open.org/committees/download.php/57596/minutes20160223.txt">approved</a> by the TC:</p>
22
27
23
-
<p>The repository manages the source code and supporting documentation for the RELAX NG-to-DTD and RELAX NG-to-XSD (and any other RNG-to-X transforms that might be developed, such as RELAX NG-to-EDD or RELAX NG-to-Schematron) transforms developed originally for use by the DITA TC in producing the <ahref="http://docs.oasis-open.org/dita/dita/v1.3/">DITA 1.3</a> DTDs and XSDs from the normative RELAX NG versions of the DITA 1.3 grammar. The converter is intended to make it easy for any DITA user to develop and maintain their own document type shells, constraint modules, and vocabulary modules using RELAX NG, which has proven to be much easier to use than DTD or XSD.</p>
28
+
<p>The repository manages the source code and supporting documentation for the RELAX NG-to-DTD and
29
+
RELAX NG-to-XSD (and any other RNG-to-X transforms that might be developed, such as RELAX
30
+
NG-to-EDD or RELAX NG-to-Schematron) transforms developed originally for use by the DITA
31
+
TC in producing the <a href="http://docs.oasis-open.org/dita/dita/v1.3/">DITA 1.3</a> and
32
+
DITA 2.x DTDs and XSDs from the normative RELAX NG versions of the DITA 1.3 and DITA 2.x
33
+
grammars. The converter is intended to make it easy for any DITA user to develop and
34
+
maintain their own document type shells, constraint modules, and vocabulary modules using
35
+
RELAX NG, which has proven to be much easier to use than DTD or XSD.</p>
24
36
25
37
</div>
26
38
@@ -29,14 +41,20 @@
29
41
<div><h3>Tool Overview</h3>
30
42
<p>
31
43
This project provides the following transforms from RNG grammars that follow the coding conventions used by the DITA Technical Committee for the TC-defined modules and shells:
32
-
<ul>
33
-
<li>RNG-to-DTD: Generates conforming DTD-syntax document type shells and modules</li>
34
-
<li>RNG-to-XSD: Generates conforming XSD-syntax document type shells and modules</li>
44
+
</p><ul>
45
+
<li>RNG-to-DTD: Generates both DTD-syntax document type shells and modules as well as single-file
46
+
("monolithic") DTDs.</li>
47
+
<li>RNG-to-XSD: Generates both modular (DITA 1.x-style) XSD-syntax document type shells and modules
48
+
that use the XSD redefine feature (within limits on the ability to generate modular
49
+
constrained XSDs) as well as "monolithic" single-file XSDs that do not use
50
+
redefine.</li>
35
51
<li>XML entity resolution catalog generator: Generates XML entity resolution catalogs for the RNG, DTD, and XSD modules processed or generated.</li>
36
52
</ul>
37
53
<p>The transforms are implemented as XSLT transforms and run through an Ant script. See the project documentation for details.</p>
38
-
<p>The transforms can be run standalone or through an Open Toolkit plugin. The transforms have no dependency on the DITA Open Toolkit itself.</p>
39
-
<p>You can use these transforms to generate both DITA 1.2 and DITA 1.3 shells and modules: RNG versions of the DITA 1.2 shells and vocabulary are included in the project (as developed by the DITA Technical Committee).</p>
54
+
<p>The transforms can be run standalone or through an Open Toolkit plug-in. The transforms have no
55
+
dependency on DITA Open Toolkit itself.</p>
56
+
<p>You can use these transforms to generate shells and modules for all DITA versions through
57
+
2.0.</p>
40
58
<p><b>NOTE:</b> At some point the OASIS-defined grammars will be removed from this project and you'll need to get the latest DITA Open Toolkit
41
59
distribution in order to minimize the number of copies of the OASIS-provided grammars.</p>
42
60
</div>
@@ -45,15 +63,15 @@ distribution in order to minimize the number of copies of the OASIS-provided gra
45
63
<p>The code as added 24 March 2016 is still under development and requires more work to make it
46
64
ready for general use. The latest code is on the develop branch.</p>
47
65
<p>The current development plan is:
48
-
<ol>
66
+
</p><ol>
49
67
<li>Fix bugs related to infinite looping of code when generating shells, as reported by
50
68
Toshihiko Makita on the DITA Community version of the repo (https://github.com/dita-community/dita-rng-converter/issues/2)</li>
51
69
<li>Refine the Ant scripts to ensure that all parameters are appropriate and working.</li>
52
70
<li>Finish documentation.</li>
53
71
</ol>
54
-
<p>Schedule: Goal is to complete these actions by the end of April 2016.</p>
72
+
<p>Schedule: Goal is to complete these actions by the end of April 2022.</p>
55
73
<p>Additional implementation goals include:
56
-
<ul>
74
+
</p><ul>
57
75
<li>Provide a simple interactive tool for creating new document type shells and generating DTD and XSD from them.</li>
58
76
<li>Implement a FrameMaker EDD generation process to make it easier to use local shells, specializations, and
59
77
constraints with FrameMaker.</li>
@@ -79,19 +97,18 @@ constraints with FrameMaker.</li>
79
97
</div>
80
98
81
99
<div><h2><aid="aboutOpenRepos">About OASIS TC Open Repositories</a></h2>
82
-
83
-
<p><ul>
84
-
<li><ahref="https://www.oasis-open.org/resources/open-repositories/">TC Open Repositories: Overview and Resources</a></li>
<li><ahref="https://www.oasis-open.org/resources/open-repositories/maintainers-guide">Maintainers' Guidelines and Agreement</a></li>
89
-
</ul></p>
90
-
100
+
<ul>
101
+
<li><ahref="https://www.oasis-open.org/resources/open-repositories/">TC Open Repositories: Overview and Resources</a></li>
<li><ahref="https://www.oasis-open.org/resources/open-repositories/maintainers-guide">Maintainers' Guidelines and Agreement</a></li>
106
+
</ul>
91
107
</div>
92
108
93
109
<div><h2><aid="feedback">Feedback</a></h2>
94
110
95
111
<p>Questions or comments about this TC Open Repository's activities should be composed as GitHub issues or comments. If use of an issue/comment is not possible or appropriate, questions may be directed by email to the Maintainer(s) <ahref="#currentMaintainers">listed above</a>. Please send general questions about TC Open Repository participation to OASIS Staff at <ahref="mailto:[email protected]">[email protected]</a> and any specific CLA-related questions to <ahref="mailto:[email protected]">[email protected]</a>.</p>
0 commit comments