← Back to branch summary

~ubuntu-branches/ubuntu/precise/kompozer/precise

« back to all changes in this revision

Viewing changes to mozilla/extensions/transformiix/docs/readme.html

  • Committer: Bazaar Package Importer
  • Author(s): Anthony Yarusso
  • Date: 2007-08-27 01:11:03 UTC
  • Revision ID: james.westby@ubuntu.com-20070827011103-2jgf4s6532gqu2ka
Tags: upstream-0.7.10
Import upstream version 0.7.10

Show diffs side-by-side

added added

removed removed

Lines of Context:
mozilla/extensions/transformiix/docs/readme.html
 
1
<HTML>
 
2
<HEAD>
 
3
<TITLE>TransforMiiX(tm)</TITLE>
 
4
<META name="author" content="Keith Visco">
 
5
</HEAD>
 
6
<BODY Text="#000000" BGColor="#FFFFFF">
 
7
<!-- OUTER TABLE -->
 
8
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" WIDTH="640">
 
9
<TR>
 
10
<TD WIDTH="80"></TD>
 
11
<TD WIDTH="80">
 
12
  <B><I><FONT SIZE="+2" COLOR="BLUE">MITRE</FONT></I></B>
 
13
</TD>
 
14
<TD WIDTH="480" ALIGN="RIGHT">
 
15
  <B><FONT SIZE="+2">Transfor<FONT Color="blue">Mii</FONT>X</FONT></B>
 
16
  <SUP>TM</SUP>
 
17
</TD>
 
18
</TR>
 
19
<TD WIDTH="80"><BR></TD>
 
20
<TD WIDTH="560" COLSPAN="2">
 
21
<!-- Contents -->
 
22
 
 
23
<HR SIZE="1" />
 
24
<BR/>
 
25
<P>
 
26
<B>Transfor<FONT Color="blue">Mii</FONT>X</B> is an XSLT processor which is
 
27
not yet complete, but supports a good portion of the 
 
28
<A HREF="http://www.w3.org/TR/1999/REC-xslt-19991116">XSLT 1.0 recommendation</A>.
 
29
 
 
30
<P>
 
31
<B>Transfor<FONT Color="blue">Mii</FONT>X</B> was designed to be a "standalone" 
 
32
XSLT processor. This means you can call the processor from the command line,
 
33
or via the XSLProcessor API. The only thing TransforMiiX requires is an XML parser,
 
34
and the currently supported parser is 
 
35
<A href="http://www.jclark.com/xml/expat.html">Expat</A> written by James Clark.
 
36
</P>
 
37
<P>
 
38
There is currently an effort undergoing to integrate 
 
39
TransforMiiX with Mozilla. This effort
 
40
is not yet complete and therefor the XSLT processor cannot yet be used 
 
41
within the Mozilla browser. Integration is nearing completion, however.
 
42
</P>
 
43
<P>
 
44
<HR SIZE="1">
 
45
<P>
 
46
<B>Running <B>Transfor<FONT Color="blue">Mii</FONT>X</B> from the command line</B>
 
47
<P />
 
48
The command line syntax is pretty straight forward:
 
49
<P>
 
50
<B>example:</B> <I>transfrmx -i my.xml -s my.xsl -o my.out</I>
 
51
</P>
 
52
This will process the XML source file called "my.xml" using the "my.xsl" XSLT stylesheet,
 
53
and the result will be placed in "my.out".
 
54
 
 
55
The "-s" flag is not required if the XSLT stylesheet is specified inside the XML source 
 
56
document using the "xml-stylesheet" PI (processing instruction).
 
57
<P>
 
58
The stylesheet PI, should appear below the XML declaration 
 
59
("<FONT SIZE="-1">&lt;?xml version="1.0"?&gt;</FONT>").
 
60
<P>
 
61
<B>example:</B>
 
62
<TABLE BGColor="" BORDER="1">
 
63
<TR>
 
64
  <TD>
 
65
    <PRE>
 
66
 
 
67
&lt;?xml version="1.0"?&gt;
 
68
&lt;?xml-stylesheet href="my.xsl" type="text/xsl"?&gt;
 
69
&lt;document&gt;
 
70
   ...
 
71
&lt;/document&gt;
 
72
    </PRE>
 
73
  </TD>
 
74
</TR>
 
75
</TABLE>
 
76
 
 
77
<P>
 
78
The command line program is in "source/main/transformiix.cpp" and is simply
 
79
a wrapper for "source/xsl/XSLProcessor.cpp" which is the TransforMiiX API.
 
80
</P>
 
81
<P>
 
82
Feel free to run the examples in the "source/examples" directory, they are a
 
83
good example of what has been implemented so far in TransforMiiX.
 
84
<P>
 
85
 
 
86
<HR SIZE="1">
 
87
<P>
 
88
<B>What is the current status of Transfor<FONT Color="blue">Mii</FONT>X</B>?
 
89
<P />
 
90
You can check the current status by looking three main files:
 
91
<UL>
 
92
<LI><A HREF="changes.txt">changes.txt</A> - lists the changes from different builds
 
93
<LI><A HREF="remaining.txt">remaining.txt</A> - lists what needs to be implemented.
 
94
<LI><A HREF="known-issues.html">known-issues.html</A> - lists known bugs or issues.
 
95
<BR />
 
96
 -- this is a little out of date...sorry.
 
97
</UL>
 
98
<P>
 
99
<HR SIZE="1">
 
100
<P>
 
101
<B>What can I do to help finish the implementation of
 
102
 Transfor<FONT Color="blue">Mii</FONT>X</B>?
 
103
<P />
 
104
There are a number of things that can be done:
 
105
<P>
 
106
<B>Development</B>
 
107
<OL>
 
108
<LI>Check out the source code, build it. 
 
109
<LI>Use it. 
 
110
<LI>Familiarize yourself with the code. 
 
111
<LI>Look at the the "to-do" or "known issues" list and choose something
 
112
that you would like to work on. 
 
113
<LI> If it's a large task, notify us that you are working on a task or issue, or
 
114
would like to contribute to the existing effort of a specific task.
 
115
<BR>
 
116
If it's a simple change you may contact us first to make sure
 
117
you are not duplicating effort, or feel free to just make the changes.
 
118
<LI>If you have CVS commit status, commit your code, 
 
119
otherwise submit your code to be integrated to us.
 
120
<BR>
 
121
<B>
 
122
<FONT SIZE="-1">
 
123
Please do a "cvs update" to make sure you have the latest changes, and that
 
124
your changes work with any code changes that might have occured during
 
125
your development. 
 
126
</FONT>
 
127
</B> 
 
128
</OL>
 
129
 
 
130
<B>Bug Reporting</B>
 
131
<OL>
 
132
<LI>Check out the source code, build it.
 
133
<LI>Use it.
 
134
<LI>Submit any bugs to the 
 
135
<A HREF="news://news.mozilla.org/netscape.public.mozilla.layout.xslt">
 
136
mailing list [netscape.public.mozilla.layout.xslt]</A>
 
137
 or directly to us.
 
138
</OL>
 
139
 
 
140
<B>Documentation</B>
 
141
<OL>
 
142
<LI>Check out the source code, build it.
 
143
<LI>Use it.
 
144
<LI>Find something that's not documented - pretty easy to do at this point.
 
145
<LI>Document #3.
 
146
<LI>If you have commit status, commit your documentation, otherwise
 
147
submit your documentation directly to us.
 
148
</OL>
 
149
<P>
 
150
 
 
151
<B>Miscellaneous (but important)</B> <BR>
 
152
<FONT SIZE="-1">&nbsp;-- I just wouldn't be myself if I didn't add these! -- Keith :-) </FONT>
 
153
<OL>
 
154
<LI>Get me a date with Claudia Schiffer or Kelly Hu.
 
155
<LI>Get me some coffee!
 
156
</OL>
 
157
<P>
 
158
<!-- End Contents -->
 
159
 
 
160
<!-- Footer -->
 
161
<HR SIZE="1">
 
162
<FONT SIZE="-1">
 
163
The MITRE Corporation, Keith Visco (C) Copyright 1999, All rights reserved<BR>
 
164
Email: <A HREF="mailto:kvisco@ziplink.net">Keith Visco</A>, 
 
165
<A HREF="mailto:tomk@mitre.org">Tom Kneeland</A>
 
166
</FONT>
 
167
<!-- End Footer -->
 
168
</TD>
 
169
</TR>
 
170
</TABLE>
 
171
<!-- End Outer Table -->
 
172
</HTML>