mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-14 15:37:55 +00:00
173 lines
5.1 KiB
HTML
173 lines
5.1 KiB
HTML
<HTML>
|
|
<HEAD>
|
|
<TITLE>TransforMiiX(tm)</TITLE>
|
|
<META name="author" content="Keith Visco">
|
|
</HEAD>
|
|
<BODY Text="#000000" BGColor="#FFFFFF">
|
|
<!-- OUTER TABLE -->
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" WIDTH="640">
|
|
<TR>
|
|
<TD WIDTH="80"></TD>
|
|
<TD WIDTH="80">
|
|
<B><I><FONT SIZE="+2" COLOR="BLUE">MITRE</FONT></I></B>
|
|
</TD>
|
|
<TD WIDTH="480" ALIGN="RIGHT">
|
|
<B><FONT SIZE="+2">Transfor<FONT Color="blue">Mii</FONT>X</FONT></B>
|
|
<SUP>TM</SUP>
|
|
</TD>
|
|
</TR>
|
|
<TD WIDTH="80"><BR></TD>
|
|
<TD WIDTH="560" COLSPAN="2">
|
|
<!-- Contents -->
|
|
|
|
<HR SIZE="1" />
|
|
<BR/>
|
|
<P>
|
|
<B>Transfor<FONT Color="blue">Mii</FONT>X</B> is an XSLT processor which is
|
|
not yet complete, but supports a good portion of the
|
|
<A HREF="http://www.w3.org/TR/1999/REC-xslt-19991116">XSLT 1.0 recommendation</A>.
|
|
|
|
<P>
|
|
<B>Transfor<FONT Color="blue">Mii</FONT>X</B> was designed to be a "standalone"
|
|
XSLT processor. This means you can call the processor from the command line,
|
|
or via the XSLProcessor API. The only thing TransforMiiX requires is an XML parser,
|
|
and the currently supported parser is
|
|
<A href="http://www.jclark.com/xml/expat.html">Expat</A> written by James Clark.
|
|
</P>
|
|
<P>
|
|
There is currently an effort undergoing to integrate
|
|
TransforMiiX with Mozilla. This effort
|
|
is not yet complete and therefor the XSLT processor cannot yet be used
|
|
within the Mozilla browser. Integration is nearing completion, however.
|
|
</P>
|
|
<P>
|
|
<HR SIZE="1">
|
|
<P>
|
|
<B>Running <B>Transfor<FONT Color="blue">Mii</FONT>X</B> from the command line</B>
|
|
<P />
|
|
The command line syntax is pretty straight forward:
|
|
<P>
|
|
<B>example:</B> <I>transfrmx -i my.xml -s my.xsl -o my.out</I>
|
|
</P>
|
|
This will process the XML source file called "my.xml" using the "my.xsl" XSLT stylesheet,
|
|
and the result will be placed in "my.out".
|
|
|
|
The "-s" flag is not required if the XSLT stylesheet is specified inside the XML source
|
|
document using the "xml-stylesheet" PI (processing instruction).
|
|
<P>
|
|
The stylesheet PI, should appear below the XML declaration
|
|
("<FONT SIZE="-1"><?xml version="1.0"?></FONT>").
|
|
<P>
|
|
<B>example:</B>
|
|
<TABLE BGColor="" BORDER="1">
|
|
<TR>
|
|
<TD>
|
|
<PRE>
|
|
|
|
<?xml version="1.0"?>
|
|
<?xml-stylesheet href="my.xsl" type="text/xsl"?>
|
|
<document>
|
|
...
|
|
</document>
|
|
</PRE>
|
|
</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<P>
|
|
The command line program is in "source/main/transformiix.cpp" and is simply
|
|
a wrapper for "source/xsl/XSLProcessor.cpp" which is the TransforMiiX API.
|
|
</P>
|
|
<P>
|
|
Feel free to run the examples in the "source/examples" directory, they are a
|
|
good example of what has been implemented so far in TransforMiiX.
|
|
<P>
|
|
|
|
<HR SIZE="1">
|
|
<P>
|
|
<B>What is the current status of Transfor<FONT Color="blue">Mii</FONT>X</B>?
|
|
<P />
|
|
You can check the current status by looking three main files:
|
|
<UL>
|
|
<LI><A HREF="changes.txt">changes.txt</A> - lists the changes from different builds
|
|
<LI><A HREF="remaining.txt">remaining.txt</A> - lists what needs to be implemented.
|
|
<LI><A HREF="known-issues.html">known-issues.html</A> - lists known bugs or issues.
|
|
<BR />
|
|
-- this is a little out of date...sorry.
|
|
</UL>
|
|
<P>
|
|
<HR SIZE="1">
|
|
<P>
|
|
<B>What can I do to help finish the implementation of
|
|
Transfor<FONT Color="blue">Mii</FONT>X</B>?
|
|
<P />
|
|
There are a number of things that can be done:
|
|
<P>
|
|
<B>Development</B>
|
|
<OL>
|
|
<LI>Check out the source code, build it.
|
|
<LI>Use it.
|
|
<LI>Familiarize yourself with the code.
|
|
<LI>Look at the the "to-do" or "known issues" list and choose something
|
|
that you would like to work on.
|
|
<LI> If it's a large task, notify us that you are working on a task or issue, or
|
|
would like to contribute to the existing effort of a specific task.
|
|
<BR>
|
|
If it's a simple change you may contact us first to make sure
|
|
you are not duplicating effort, or feel free to just make the changes.
|
|
<LI>If you have CVS commit status, commit your code,
|
|
otherwise submit your code to be integrated to us.
|
|
<BR>
|
|
<B>
|
|
<FONT SIZE="-1">
|
|
Please do a "cvs update" to make sure you have the latest changes, and that
|
|
your changes work with any code changes that might have occured during
|
|
your development.
|
|
</FONT>
|
|
</B>
|
|
</OL>
|
|
|
|
<B>Bug Reporting</B>
|
|
<OL>
|
|
<LI>Check out the source code, build it.
|
|
<LI>Use it.
|
|
<LI>Submit any bugs to the
|
|
<A HREF="news://news.mozilla.org/netscape.public.mozilla.layout.xslt">
|
|
mailing list [netscape.public.mozilla.layout.xslt]</A>
|
|
or directly to us.
|
|
</OL>
|
|
|
|
<B>Documentation</B>
|
|
<OL>
|
|
<LI>Check out the source code, build it.
|
|
<LI>Use it.
|
|
<LI>Find something that's not documented - pretty easy to do at this point.
|
|
<LI>Document #3.
|
|
<LI>If you have commit status, commit your documentation, otherwise
|
|
submit your documentation directly to us.
|
|
</OL>
|
|
<P>
|
|
|
|
<B>Miscellaneous (but important)</B> <BR>
|
|
<FONT SIZE="-1"> -- I just wouldn't be myself if I didn't add these! -- Keith :-) </FONT>
|
|
<OL>
|
|
<LI>Get me a date with Claudia Schiffer or Kelly Hu.
|
|
<LI>Get me some coffee!
|
|
</OL>
|
|
<P>
|
|
<!-- End Contents -->
|
|
|
|
<!-- Footer -->
|
|
<HR SIZE="1">
|
|
<FONT SIZE="-1">
|
|
The MITRE Corporation, Keith Visco (C) Copyright 1999, All rights reserved<BR>
|
|
Email: <A HREF="mailto:kvisco@ziplink.net">Keith Visco</A>,
|
|
<A HREF="mailto:tomk@mitre.org">Tom Kneeland</A>
|
|
</FONT>
|
|
<!-- End Footer -->
|
|
</TD>
|
|
</TR>
|
|
</TABLE>
|
|
<!-- End Outer Table -->
|
|
</HTML>
|