diff options
author | Fred Drake <fdrake@acm.org> | 2001-07-09 16:04:03 (GMT) |
---|---|---|
committer | Fred Drake <fdrake@acm.org> | 2001-07-09 16:04:03 (GMT) |
commit | 67f193faabcaa96e3a18ebde637986aafac6f5a7 (patch) | |
tree | d4d34af9e16174d404424154d8d7f5a08f7e4b4a /Doc/doc | |
parent | 03e88da81b39c16b52b4caaa2d166b12c4d38a41 (diff) | |
download | cpython-67f193faabcaa96e3a18ebde637986aafac6f5a7.zip cpython-67f193faabcaa96e3a18ebde637986aafac6f5a7.tar.gz cpython-67f193faabcaa96e3a18ebde637986aafac6f5a7.tar.bz2 |
Add a little bit more about the XML migration plan. This still needs a lot
of work, but mostly it needs time spent doing the work to make the
generated XML useful.
Diffstat (limited to 'Doc/doc')
-rw-r--r-- | Doc/doc/doc.tex | 27 |
1 files changed, 23 insertions, 4 deletions
diff --git a/Doc/doc/doc.tex b/Doc/doc/doc.tex index e92ad9a..7069f2f 100644 --- a/Doc/doc/doc.tex +++ b/Doc/doc/doc.tex @@ -1062,7 +1062,7 @@ This \UNIX\ is also followed by a space. be used for an advantage when the documents are processed using the tools for Python documentation processing. In particular, the generated HTML looks good! There is also an advantage for the - eventual conversion of the documentation to SGML (see section + eventual conversion of the documentation to XML (see section \ref{futures}, ``Future Directions''). Each environment is named \env{table\var{cols}}, where \var{cols} @@ -1585,7 +1585,7 @@ This \UNIX\ is also followed by a space. SGML offers advantages which may appeal most to authors, especially those using ordinary text editors. There are also additional abilities to define content models. A number of - high-quality tools with demonstrated maturity is available, but + high-quality tools with demonstrated maturity are available, but most are not free; for those which are, portability issues remain a problem. @@ -1597,9 +1597,28 @@ This \UNIX\ is also followed by a space. short term. The promised availability of a wide variety of high-quality tools which support some of the most important related standards is not immediate. Many tools are likely to be - free. + free, and the portability issues of those which are, are not + expected to be significant. + + It turns out that converting to an XML or SGML system holds + promise for translators as well; how much can be done to ease the + burden on translators remains to be seen, and may have some impact + on the schema and specific technologies used. + + XXX Eventual migration to XML. + + The documentation will be moved to XML in the future, and tools + are being written which will convert the documentation from the + current format to something close to a finished version, to the + extent that the desired information is already present in the + documentation. Some XSLT stylesheets have been started for + presenting a preliminary XML version as HTML, but the results are + fairly rough.. + + The timeframe for the conversion is not clear since there doesn't + seem to be much time available to work on this, but the appearant + benefits are growing more substantial at a moderately rapid pace. - XXX Eventual migration to SGML/XML. \subsection{Discussion Forums \label{discussion}} |