Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 67f193f

Browse files
committed
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.
1 parent 03e88da commit 67f193f

1 file changed

Lines changed: 23 additions & 4 deletions

File tree

Doc/doc/doc.tex

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1062,7 +1062,7 @@ \section{\module{bar.foo} ---
10621062
be used for an advantage when the documents are processed using
10631063
the tools for Python documentation processing. In particular, the
10641064
generated HTML looks good! There is also an advantage for the
1065-
eventual conversion of the documentation to SGML (see section
1065+
eventual conversion of the documentation to XML (see section
10661066
\ref{futures}, ``Future Directions'').
10671067

10681068
Each environment is named \env{table\var{cols}}, where \var{cols}
@@ -1585,7 +1585,7 @@ \section{Future Directions \label{futures}}
15851585
SGML offers advantages which may appeal most to authors,
15861586
especially those using ordinary text editors. There are also
15871587
additional abilities to define content models. A number of
1588-
high-quality tools with demonstrated maturity is available, but
1588+
high-quality tools with demonstrated maturity are available, but
15891589
most are not free; for those which are, portability issues remain
15901590
a problem.
15911591

@@ -1597,9 +1597,28 @@ \section{Future Directions \label{futures}}
15971597
short term. The promised availability of a wide variety of
15981598
high-quality tools which support some of the most important
15991599
related standards is not immediate. Many tools are likely to be
1600-
free.
1600+
free, and the portability issues of those which are, are not
1601+
expected to be significant.
1602+
1603+
It turns out that converting to an XML or SGML system holds
1604+
promise for translators as well; how much can be done to ease the
1605+
burden on translators remains to be seen, and may have some impact
1606+
on the schema and specific technologies used.
1607+
1608+
XXX Eventual migration to XML.
1609+
1610+
The documentation will be moved to XML in the future, and tools
1611+
are being written which will convert the documentation from the
1612+
current format to something close to a finished version, to the
1613+
extent that the desired information is already present in the
1614+
documentation. Some XSLT stylesheets have been started for
1615+
presenting a preliminary XML version as HTML, but the results are
1616+
fairly rough..
1617+
1618+
The timeframe for the conversion is not clear since there doesn't
1619+
seem to be much time available to work on this, but the appearant
1620+
benefits are growing more substantial at a moderately rapid pace.
16011621

1602-
XXX Eventual migration to SGML/XML.
16031622

16041623
\subsection{Discussion Forums \label{discussion}}
16051624

0 commit comments

Comments
 (0)