Apache OpenOffice Wiki - User contributions [en]

SmartArt

2008-02-07T15:07:32Z

Hub: /* Import */

= SmartArt =

SmartArt is one of the new features of MS-Office 2007 and is about simply creating diagrams automatically. You select a layout, select colors, enter some textual data, and voilà.

This is the diagram part of [[DrawingML]]

== Import ==

The current strategy to import is to generate shapes from the diagram data. The result will be lossy compared to the [[Office Open XML]] document as it will not include the diagram information anymore. Don't expect round-trip conversion.

The code is in source/drawingml/diagram in the [[Oox]] module.

== Generation ==

The generation of a SmartArt is the action of generating drawing elements from the data model, layout and color style combination.

== Future? ==

This is just ideas for the future. These are not actual plans.

Ideally in the future, OpenOffice.org could have a similar feature with a UI. That would require changes in both the file format and the importer. It could be written as an extension, and should be available to all the OpenOffice.org components: Writer, Calc, Draw and Impress.

Ideally the file format changes could mandate to have a pre-rendered representation of the diagram in order to not require to implement the feature in other readers.

== Links ==

* [http://msdn.microsoft.com/msdnmag/issues/07/02/SmartArt/?topics=/msdnmag/issues/07/02/SmartArt Creating custom Smart Art]: provide a better understanding of the underlying layout model.

[[Category:Office Open XML]]
[[Category:Impress]]

SmartArt

2008-02-07T15:06:43Z

Hub: /* Future? */

= SmartArt =

SmartArt is one of the new features of MS-Office 2007 and is about simply creating diagrams automatically. You select a layout, select colors, enter some textual data, and voilà.

This is the diagram part of [[DrawingML]]

== Import ==

The current strategy to import is to generate shapes from the diagram data. The result will be lossy compared to the [[Office Open XML]] document as it will not include the diagram information anymore. Don't expect round-trip conversion.

== Generation ==

The generation of a SmartArt is the action of generating drawing elements from the data model, layout and color style combination.

== Future? ==

This is just ideas for the future. These are not actual plans.

Ideally in the future, OpenOffice.org could have a similar feature with a UI. That would require changes in both the file format and the importer. It could be written as an extension, and should be available to all the OpenOffice.org components: Writer, Calc, Draw and Impress.

Ideally the file format changes could mandate to have a pre-rendered representation of the diagram in order to not require to implement the feature in other readers.

== Links ==

* [http://msdn.microsoft.com/msdnmag/issues/07/02/SmartArt/?topics=/msdnmag/issues/07/02/SmartArt Creating custom Smart Art]: provide a better understanding of the underlying layout model.

[[Category:Office Open XML]]
[[Category:Impress]]

SmartArt

2008-02-07T15:04:58Z

Hub: /* Future? */

= SmartArt =

SmartArt is one of the new features of MS-Office 2007 and is about simply creating diagrams automatically. You select a layout, select colors, enter some textual data, and voilà.

This is the diagram part of [[DrawingML]]

== Import ==

The current strategy to import is to generate shapes from the diagram data. The result will be lossy compared to the [[Office Open XML]] document as it will not include the diagram information anymore. Don't expect round-trip conversion.

== Generation ==

The generation of a SmartArt is the action of generating drawing elements from the data model, layout and color style combination.

== Future? ==

This is just ideas for the future. These are not actual plans.

Ideally in the future, OpenOffice.org could have a similar feature with a UI. That would require changes in both the file format and the importer. It could be written as an extension, and should be available to all the OpenOffice.org components: Writer, Calc, Draw and Impress.

Ideally the file format changes could mandate to have a pre-rendered representation of the diagram in order to no require to implement the feature in other reader.

== Links ==

* [http://msdn.microsoft.com/msdnmag/issues/07/02/SmartArt/?topics=/msdnmag/issues/07/02/SmartArt Creating custom Smart Art]: provide a better understanding of the underlying layout model.

[[Category:Office Open XML]]
[[Category:Impress]]

Office Open XML/Legacy Implementation

2008-01-24T00:46:28Z

Hub: xmlfilter03

= OOXML Basics =

"Office Open XML" is an XML based file format that has been published as [http://www.ecma-international.org/publications/standards/Ecma-376.htm ECMA-376]. It is used as default file format by Microsoft Office 2007.

There are plans to support this file format in OpenOffice.org for interoperation with Microsoft Office 2007.

There are 3 major types of formats

* [[WordprocessingML]] - For word processor documents (file extensions may be docx, docm)
* [[SpreadsheetML]] - For spreadsheet documents (file extensions may be xlsx, xlsm)
* [[PresentationML]] - For presentation documents (file extensions may be pptx, pptm)
* [[DrawingML]] - Used by other markup language to represent graphics data.
* [[VML]] - A legacy vector markup.

== Packaging Conventions ==
OpenXML document is a package that consists of a flat collection of '''"parts"'''. Each "part" has a case-''insensitive'' part name that consists of a slash (/) delimited sequence of segment names such as "/pres/slides/slide1.xml".

For the most part, the ZIP compression is used to package the parts, in which case the term '''"package"''' refers to the ZIP archive, and the parts refer to the individual files archived within. The part name in this case is the file path within the archive.

Each part also has a '''content type''', and '''/[Content_Types].xml''' provides the content type of each part within the archive.

== Relationships ==
Packages and parts can contains '''explicit relationships''' to other parts as well as to external resources. Every explicit relationship has an ID and a type, and relationship types are named using URIs.

The set of explicit relationships for each package or part is stored in a relationship part whose name (or path) follows a specific convention e.g. the relationship part for a part called '''"/a/b/c.xml"''' is called '''"/a/b/_rels/c.xml.rels"'''. As a special case, the relationship part for the package as a whole is called '''"/_rels/.rels"'''.

= OO.o Implementation =
There is some code in the oox module ([[OOX]]) from the [[Xml]] project. Its initial version from the CWS xmlfilter02 has been integrated into SRC680_m243. The continuing [[CWS]] is xmlfilter03 in SRC680. ([http://eis.services.openoffice.org/EIS2/cws.ShowCWS?Path=SRC680%2Fxmlfilter03 view the workspace on EIS])

To fetch the oox code from CVS (using CVSROOT is set properly):

cvs co -r cws_src680_xmlfilter03 -d oox xml/oox

One important note: we use the term '''fragment''' in the name of our source files to correspond with what the standard calls '''part'''. For instance, the source file that contains class definition that handles the workbook part in [[SpreadsheetML]] is called workbookfragment.cxx. This convention is prevalent across all application types within [[oox]] module.

Bonsai is also convenient to follow the changes:

[http://bonsai.go-oo.org/cvsquery.cgi?treeid=default&module=all&branch=cws_src680_xmlfilter03&branchtype=match&dir=xml%2Foox&file=&filetype=match&who=&whotype=match&sortby=Date&hours=2&date=week&mindate=&maxdate=&cvsroot=%2Fhome%2Fooweb%2Fcvsup the changes done in the last 2 weeks]

Word document import is in the [[WriterFilter|writerfilter]] module.

== Implementation Generalities ==

The whole [[OOX]] filter makes use of the new [[FastParser]] service to implement an event driven [[SAX]] parser.

== Various Resources ==

* [[OpenOffice_filters_using_the_XML_based_file_format|OpenOffice filters using the XML based file format]]
* [http://books.evc-cit.info/ OASIS OpenDocument Essentials]
* http://blogs.sun.com/GullFOSS/entry/office_open_xml_import_filter
* [http://eis.services.openoffice.org/EIS2/cws.ShowCWS?Path=SRC680%2Fxmlfilter03 CWS on EIS]
* [http://www.ecma-international.org/publications/standards/Ecma-376.htm ECMA published standard]
* [http://www.ecma-international.org/news/TC45_current_work/TC45_available_docs.htm Ecma Office Open XML File Formats Standard]
* [http://blogs.msdn.com/brian_jones/archive/2005/06/20/430892.aspx Brian Jones introduction to the Office 12 File Format]

[[Category:Filter]]
[[Category:Office Open XML]]

Oox

2008-01-24T00:43:54Z

Hub: release in m243

Stands for [[Office Open XML]]. The name of the module that handle [[Office Open XML]] import. Part of the [[Xml]] project.

The Oox module has been integrated in SRC680_m243. That does not mean it is finished, just that it is in some usable state to inquire for more feedback.

= Note =

The [[WordprocessingML]] importer is part of a different effort in writerfilter2 where the refactoring of the binary and RTF filter also takes place.

= Directory Structure =
== core ==
This directory includes common code for all filters.

=== AttributeList (class) ===
Provides access to attribute values of an element. '''AttributeList''' wraps a ''com.sun.star.xml.sax.XFastAttributeList'' object, and provides convenience functions that convert the string value of an attribute to various other data types. This class is usually used as a local variable declared with an instance of [[XFastAttributeList]] passed from the [[FastParser]] instance.

=== FragmentHandler (class) ===
Top-most parent class that handles fragments. In most cases this class handles all nested contexts for increased performance. This class implements [[XFastDocumentHandler]] interface.

=== RelationsFragmentHandler (class) ===
Handles loading of relationships fragments ( '''/*/_rels/*.rels''' ). Like the FragmentHandler class, this class also implements [[XFastDocumentHandler]] interface.

=== ImportBase (class) ===
The base class for application specific import filters, currently sub-classed by '''oox::ppt::PowerPointImport''' and '''oox::xls::ExcelFilter'''. It implements [http://api.openoffice.org/docs/common/ref/com/sun/star/document/XImporter.html XImporter] and [http://api.openoffice.org/docs/common/ref/com/sun/star/document/XFilter.html XFilter] interfaces.

== drawingml ==

drawingml containg the [[DrawingML]] parsing code.

== ppt ==

ppt contain the [[PresentationML]] parsing code.

== token ==

The token list is generated by parsing the XML Schemas. Then gentoken.pl will use gperf to generate a perfect hash for fast parsing of known tokens. All the token are dispatched through integer numbers.

== xls ==
This directory includes code specific to parse [[SpreadsheetML]].

[[Category:Office Open XML]]
[[Category:Source_directories]]
[[Category:Filter]]

SmartArt

2007-12-17T20:11:19Z

Hub: /* Links */

= SmartArt =

SmartArt is one of the new features of MS-Office 2007 and is about simply creating diagrams automatically. You select a layout, select colors, enter some textual data, and voilà.

This is the diagram part of [[DrawingML]]

== Import ==

The current strategy to import is to generate shapes from the diagram data. The result will be lossy compared to the [[Office Open XML]] document as it will not include the diagram information anymore. Don't expect round-trip conversion.

== Generation ==

The generation of a SmartArt is the action of generating drawing elements from the data model, layout and color style combination.

== Future? ==

This is just ideas for the future. These are not actual plans.

Ideally in the future, OpenOffice.org could have a similar feature with a UI. That would require changes in both the file format and the importer. It could be written as an extension, and should be available to all the OpenOffice.org components: Writer, Calc, Draw and Impress.

== Links ==

* [http://msdn.microsoft.com/msdnmag/issues/07/02/SmartArt/?topics=/msdnmag/issues/07/02/SmartArt Creating custom Smart Art]: provide a better understanding of the underlying layout model.

[[Category:Office Open XML]]
[[Category:Impress]]

SmartArt

2007-12-14T19:38:59Z

Hub:

= SmartArt =

SmartArt is one of the new features of MS-Office 2007 and is about simply creating diagrams automatically. You select a layout, select colors, enter some textual data, and voilà.

This is the diagram part of [[DrawingML]]

== Import ==

The current strategy to import is to generate shapes from the diagram data. The result will be lossy compared to the [[Office Open XML]] document as it will not include the diagram information anymore. Don't expect round-trip conversion.

== Generation ==

The generation of a SmartArt is the action of generating drawing elements from the data model, layout and color style combination.

== Future? ==

This is just ideas for the future. These are not actual plans.

Ideally in the future, OpenOffice.org could have a similar feature with a UI. That would require changes in both the file format and the importer. It could be written as an extension, and should be available to all the OpenOffice.org components: Writer, Calc, Draw and Impress.

== Links ==

* [http://msdn.microsoft.com/msdnmag/issues/07/02/SmartArt/?topics=/msdnmag/issues/07/02/SmartArt Creating custom Smart Art]: provide a better understanding of the underlying data model.

[[Category:Office Open XML]]
[[Category:Impress]]

PowerPoint filter

2007-11-06T08:15:59Z

Hub: /* Export */

The PowerPoint filter is in charge of importing and exporting from/to PowerPoint binary documents (.PPT) into [[Impress]]. If you are a looking for the PPTX files from PowerPoint 2007, please go to the [[Office Open XML]].

The [[PowerPoint filter]] is maintained by [[User:Sj|Sven Jacobi]].

== Import ==

The import code is scattered between the svx and sd modules.
Relevant files are in:
* sd/source/filter/ppt
* svx/source/svdraw/svdfppt.cxx

== Export ==

The export code is contained in sd/source/filter/eppt

PPTWriter is the main class that will write the binary stream. Its implementation is spread accross eppt.cxx and epptso.cxx.

[[Category:Impress]]
[[Category:Filter]]

XML and Filter

2007-11-01T18:29:02Z

Hub: to filter category

We want in this chapter examine how XML and filters work.
= Parsing a XML File with SAX =
To start, have a look at :

[http://www.oooforum.org/forum/viewtopic.phtml?t=4907 Using UNO's Xml sax parser via the API]

It's a [[CppSDKAuthors|Danny Brewer's]] OooBasic program which use SAX. To avoid searching I begin to give the code here.
== Sax and OooBasic (Danny Brewer) ==

This example demonstrates several things.

* Using the UCB's SimpleFileAccess to read from a file. (UCB = Universal Content Broker)

* Using OOo's XML sax parser.

* Creating a listener with Basic's CreateUnoListener() function.

If you have never used a Sax Xml parser before, then this example may not be for you.

OOo has a Sax Xml parser available via. the Uno api. The following program, in Basic, shows how to use it to parse an Xml document. As the document is parsed, events are fired which print little annoying dialog boxes on the screen. (Be sure to parse a VERY SMALL xml document so that you only have to click OK about a dozen or so times!)
<code>[oobas]

REM Listing 1 Using SAX with OooBasic
REM ***** BASIC *****
REM **** Danny Brewer (Mon Jan 12, 2004) ****
Sub Main
cXmlFile = "C:\TestData.xml"
cXmlUrl = ConvertToURL( cXmlFile )
ReadXmlFromUrl( cXmlUrl )
End Sub

' This routine demonstrates how to use the Universal Content Broker's
' SimpleFileAccess to read from a local file.
Sub ReadXmlFromUrl( cUrl )
' The SimpleFileAccess service provides mechanisms to open, read, write files,
' as well as scan the directories of folders to see what they contain.
' The advantage of this over Basic's ugly file manipulation is that this
' technique works the same way in any programming language.
' Furthermore, the program could be running on one machine, while the SimpleFileAccess
' accesses files from the point of view of the machine running OOo, not the machine
' where, say a remote Java or Python program is running.
oSimpleFileAccess = createUnoService( "com.sun.star.ucb.SimpleFileAccess" )
' Open input file.
oInputStream = oSimpleFileAccess.openFileRead( cUrl )

ReadXmlFromInputStream( oInputStream )
oInputStream.closeInput()
End Sub

Sub ReadXmlFromInputStream( oInputStream )
' Create a Sax Xml parser.
oSaxParser = createUnoService( "com.sun.star.xml.sax.Parser" )
' Create a document event handler object.
' As methods of this object are called, Basic arranges
' for global routines (see below) to be called.
oDocEventsHandler = CreateDocumentHandler()
' Plug our event handler into the parser.
' As the parser reads an Xml document, it calls methods
' of the object, and hence global subroutines below
' to notify them of what it is seeing within the Xml document.
oSaxParser.setDocumentHandler( oDocEventsHandler )
' Create an InputSource structure.
oInputSource = createUnoStruct( "com.sun.star.xml.sax.InputSource" )
With oInputSource
.aInputStream = oInputStream ' plug in the input stream
End With
' Now parse the document.
' This reads in the entire document.
' Methods of the oDocEventsHandler object are called as
' the document is scanned.
oSaxParser.parseStream( oInputSource )
End Sub

'==================================================
' Xml Sax document handler.
'==================================================
' Global variables used by our document handler.
'
' Once the Sax parser has given us a document locator,
' the glLocatorSet variable is set to True,
' and the goLocator contains the locator object.
'
' The methods of the locator object has cool methods
' which can tell you where within the current Xml document
' being parsed that the current Sax event occured.
' The locator object implements com.sun.star.xml.sax.XLocator.
'
Private goLocator As Object
Private glLocatorSet As Boolean

' This creates an object which implements the interface
' com.sun.star.xml.sax.XDocumentHandler.
' The doucment handler is returned as the function result.
Function CreateDocumentHandler()
' Use the CreateUnoListener function of Basic.
' Basic creates and returns an object that implements a particular interface.
' When methods of that object are called,
' Basic will call global Basic functions whose names are the same
' as the methods, but prefixed with a certian prefix.
oDocHandler = CreateUnoListener( "DocHandler_", "com.sun.star.xml.sax.XDocumentHandler" )
glLocatorSet = False
CreateDocumentHandler() = oDocHandler
End Function

'==================================================
' Methods of our document handler call these
' global functions.
' These methods look strangely similar to
' a SAX event handler. ;-)
' These global routines are called by the Sax parser
' as it reads in an XML document.
' These subroutines must be named with a prefix that is
' followed by the event name of the com.sun.star.xml.sax.XDocumentHandler interface.
'==================================================
Sub DocHandler_startDocument()
Print "Start document"
End Sub

Sub DocHandler_endDocument()
' Print "End document"
End Sub

Sub DocHandler_startElement( cName As String, oAttributes As com.sun.star.xml.sax.XAttributeList )
Print "Start element", cName
End Sub

Sub DocHandler_endElement( cName As String )
' Print "End element", cName
End Sub

Sub DocHandler_characters( cChars As String )
End Sub

Sub DocHandler_ignorableWhitespace( cWhitespace As String )
End Sub

Sub DocHandler_processingInstruction( cTarget As String, cData As String )
End Sub

Sub DocHandler_setDocumentLocator( oLocator As com.sun.star.xml.sax.XLocator )
' Save the locator object in a global variable.
' The locator object has valuable methods that we can
' call to determine
goLocator = oLocator
glLocatorSet = True
End Sub
</code>

This code installs an eventListener with a com.sun.star.xml.sax.XDocumentHandler interface.The corresponding IDL documentation of this interface is :

<code>[nowiki]
//Listing 2 IDL XdocumentHandler Interface
// IDL
module com { module sun { module star { module xml { module sax {
interface XDocumentHandler: com::sun::star::uno::XInterface
{
void startDocument()
raises( com::sun::star::xml::sax::SAXException );
void endDocument()
raises( com::sun::star::xml::sax::SAXException );
void startElement( [in] string aName,
[in] com::sun::star::xml::sax::XAttributeList xAttribs )
raises( com::sun::star::xml::sax::SAXException );
void endElement( [in] string aName )
raises( com::sun::star::xml::sax::SAXException );
void characters( [in] string aChars )
raises( com::sun::star::xml::sax::SAXException );
void ignorableWhitespace( [in] string aWhitespaces )
raises( com::sun::star::xml::sax::SAXException );
void processingInstruction( [in] string aTarget,
[in] string aData )
raises( com::sun::star::xml::sax::SAXException );
void setDocumentLocator( [in] com::sun::star::xml::sax::XLocator xLocator )
raises( com::sun::star::xml::sax::SAXException );
};
}; }; }; }; };
</code>
You can find the complete implementation of this interface in the OooBasic code of Listing 1.
We have then to write an Event Listener in C++. If you want to remember how Event Listener works in C++ have a look [[OpenOffice_Calc#Event_Listener |here]].

==The C++ Event Listener==
We have first to create a C++ class :
<code>[cpp]
//Listing 3 Class Definition (could be in hxx file)
// C++
class XFlatXml : public ::cppu::WeakImplHelper1< ::com::sun::star::xml::sax::XDocumentHandler>
{
private:
Reference< XMultiServiceFactory > xMSF;
public:

XFlatXml( const Reference< XMultiServiceFactory > &r ) : xMSF( r )
{}

// Reference < com::sun::star::io::XOutputStream > xOutputStream;
virtual void SAL_CALL startDocument() throw (SAXException,RuntimeException) ;
virtual void SAL_CALL endDocument() throw (SAXException,RuntimeException);
virtual void SAL_CALL startElement(const OUString& str, const Reference<XAttributeList>& attriblist) throw (SAXException,RuntimeException);
virtual void SAL_CALL endElement(const OUString& str) throw (SAXException,RuntimeException);
virtual void SAL_CALL characters(const OUString& str) throw (SAXException,RuntimeException);
virtual void SAL_CALL ignorableWhitespace(const OUString& str) throw (SAXException,RuntimeException);
virtual void SAL_CALL processingInstruction(const OUString& str, const OUString& str2) throw (SAXException,RuntimeException) ;
virtual void SAL_CALL setDocumentLocator(const Reference<XLocator>& doclocator) throw (SAXException,RuntimeException) ;
};
</code>
A C++ correponding implementation code could be
<code>[cpp]
//Listing 4 The Event Listener Class Implementation
// C++
void XFlatXml::startDocument() throw (SAXException,RuntimeException){
printf("StartDocument\n");
}

void XFlatXml::endDocument() throw (SAXException,RuntimeException){
printf("EndDocument\n");
}

void XFlatXml::startElement(const OUString& str, const Reference<XAttributeList>& attriblist) throw (SAXException,RuntimeException){
Ostring OStr = OUStringToOString ( str,RTL_TEXTENCODING_UTF8);
cout<< "StartElement : <" << OStr << " ";
for (short i=0;i<attriblist->getLength();i++){
OStr = OUStringToOString ( attriblist->getNameByIndex(i),RTL_TEXTENCODING_UTF8);
cout << OStr <<"=";
OStr = OUStringToOString ( attriblist->getValueByIndex(i),RTL_TEXTENCODING_UTF8);
cout << OStr;
}
cout << ">" << endl;
}

void XFlatXml::endElement(const OUString& str) throw (SAXException,RuntimeException) {
Ostring OStr = OUStringToOString ( str,RTL_TEXTENCODING_UTF8);
cout<< "EndElement : </" << OStr << ">" << endl;
}

void XFlatXml::characters(const OUString& str) throw (SAXException,RuntimeException) {
OString OStr = OUStringToOString ( str,RTL_TEXTENCODING_UTF8);
cout<< "Characers : " << OStr << endl;
}

void XFlatXml::ignorableWhitespace(const OUString& str) throw (SAXException,RuntimeException){
printf("ignorableWhitespace\n");
}

void XFlatXml::processingInstruction(const OUString& str, const OUString& str2) throw (SAXException,RuntimeException) {
printf("processingInstruction\n");

}

void XFlatXml::setDocumentLocator(const Reference<XLocator>& doclocator) throw (SAXException,RuntimeException) {
printf("setDocumentLocator\n");
}
</code>
Now it's time to make this event listener working.

== Main Program ==
<code>[cpp]
//Listing 5 The Main Program
// C++
int main( )
{
//retrieve an instance of the remote service manager
Reference< XMultiServiceFactory > rOfficeServiceManager;
rOfficeServiceManager = ooConnect();
OSL_ENSURE(rOfficeServiceManager.is(), "Unable to connected to the office\n");

// Installing our new XDocumentHandler
XFlatXml *xListener = new XFlatXml(rOfficeServiceManager);
Reference< XDocumentHandler > xHandler = static_cast< XDocumentHandler* > ( xListener );
// getting oSimpleFileAcess
// com.sun.star.ucb.XSimpleFileAccess \ added in makefile
// #include <com/sun/star/ucb/XSimpleFileAccess.hpp> added in this file
// using namespace com::sun::star::ucb; added in this file
Reference< XSimpleFileAccess > xSFI( rOfficeServiceManager->createInstance
(OUString::createFromAscii("com.sun.star.ucb.SimpleFileAccess")),UNO_QUERY);
OSL_ENSURE(xSFI.is(), "Unable to get SimpleFileAcessService\n");

// Don't forget #include <osl/file.hxx>
OUStr sUrl;
osl::FileBase::getFileURLFromSystemPath(
OUString::createFromAscii("/home/smoutou/TestData.xml"),sUrl);

// getting oInputStream
// using namespace com::sun::star::io; added in this file
Reference <XInputStream > oInputStream=xSFI->openFileRead(sUrl);

// oSaxParser = createUnoService( "com.sun.star.xml.sax.Parser" )
// com.sun.star.xml.sax.XParser \ added in Makefile
//#include <com/sun/star/xml/sax/XParser.hpp> added in this file
Reference < XParser > oSaxParser( rOfficeServiceManager->createInstance
( OUString::createFromAscii( "com.sun.star.xml.sax.Parser" ) ), UNO_QUERY );
OSL_ENSURE(oSaxParser.is(), "Unable to get Sax Parser\n");
oSaxParser->setDocumentHandler( xHandler );

// com.sun.star.xml.sax.InputSource \ added in Makefile
// #include <com/sun/star/xml/sax/InputSource.hpp> added in this file
struct InputSource oInputSource;
oInputSource.aInputStream = oInputStream;

oSaxParser->parseStream(oInputSource);
oInputStream->closeInput();
return 0;
}
</code>
To test how the program works we have to provide a XML file. We can take Danny's example :

'''Listing 6 XML file for test
<code>[xml]
<Employees>
<Employee id="101">
<Name>
<First>John</First>
<Last>Smith</Last>
</Name>
<Address>
<Street>123 Main</Street>
<City>Lawrence</City>
<State>KS</State>
<Zip>66049</Zip>
</Address>
<Phone type="Home">785-555-1234</Phone>
</Employee>
<Employee id="102">
<Name>
<First>Bob</First>
<Last>Jones</Last>
</Name>
<Address>
<Street>456 Puke Drive</Street>
<City>Lawrence</City>
<State>KS</State>
<Zip>66049</Zip>
</Address>
<Phone type="Home">785-555-1235</Phone>
</Employee>
</Employees>
</code>
This file prints out in a shell :

'''Listing 7 Result
<code>[nowiki]
setDocumentLocator
StartDocument
StartElement : <Employees >
Characers :

Characers :
StartElement : <Employee id=101>
Characers :

Characers :
StartElement : <Name >
Characers :

Characers :
StartElement : <First >
Characers : John
EndElement : </First>
Characers :

Characers :
StartElement : <Last >
Characers : Smith
EndElement : </Last>
Characers :

Characers :
.....
</code>

= Writing directly XML Instructions in a Document =

Since I read [http://xml.openoffice.org/filter/ OpenOffice.org filters using the XML based file format] I wanted to understand exactly the concepts and make some working code. It was for me a very hard task : I have to read extensively OOo source code because the example code given in the article cannot work without little corrections. I finally found the clues in :
*<OOB680_m5>/filter/source/xsltdialog (attributelist.hxx and the corresponding attributelist.cxx)
*<OOB680_m5>/filter/source/xmlfilteradaptor/XmlFilterAdaptor.cxx

== Our Goal and the corresponding Code ==

Our goal is very well described in the comments of the Listing 9 below (given again in Listing 8): send the XML text in a document which gives the famous « Hello World! » into a writer document. The difficulty is, we don't want to see all the Listing 8 in our writer document but only the text « Hello World! » as a paragraph : this is the meaning of the corresponding XML text.

'''Listing 8 What we would want to send in a Writer Document for interpretation
<code>[xml]
<office:document
office:class="text"
xmlns:office="http://openoffice.org/2000/office"
xmlns:text="http://openoffice.org/2000/text" >
<office:body>
<text:p>Hello World!</text:p>
</office:body>
</office:document>
</code>
Please note that, at the moment it's the only XML program I can send to Openoffice and every others don't work.

I provide now the code [http://xml.openoffice.org/filter/ from the XML article] where I have added comments which show the little errors in the code.
<code>[cpp]
//Listing 9 http://xml.openoffice.org/filter/Code
// C++
using namespace ::com::sun::star;

// instantiate the XML import component !!!! fell a ';' !!!!
::rtl::OUString sService =
::rtl::OUString::createFromAscii("com.sun.star.comp.Writer.XMLImporter")
// !!!!!!!!! xHandler instead of xImport because xHandler is used below
uno::Reference<xml::sax::XDocumentHandler> xImport(
xServiceFactory->createInstance(sService), uno::UNO_QUERY );
ASSERT( xImport.is(), "can't instantiate XML import" );

// OK. Now we have the import. Let's make a real simple document.

// a few comments:
// 1. We will use string constants from xmloff/xmlkywd.hxx
// 2. For convenience, we'll use a globally shared attribute list from the
// xmloff project (xmloff/attrlist.hxx)
// 3. In a real project, we would pre-construct our OUString, rather than use
// the slow createFromAscii(…) method every time.

// We will write the following document: (the unavoidable 'Hello World!')
// <office:document
// office:class="text"
// xmlns:office="http://openoffice.org/2000/office"
// xmlns:text="http://openoffice.org/2000/text" >
// <office:body>
// <text:p>Hello World!</text:p>
// </office:body>
// </office:document>

SvXMLAttributeList aAttrList;

xHandler->startDocument();

// our first element: first build up the attribute list, then start the element
// DON'T FORGET TO ADD THE NAMESPACES!
aAttrList.AddAttribute(
::rtl::OUString::createFromAscii("xmlns:office"),
::rtl::OUString::createFromAscii("CDATA"),
::rtl::OUString::createFromAscii("http://openoffice.org/2000/office") );
aAttrList.AddAttribute(
::rtl::OUString::createFromAscii("xmlns:text"),
::rtl::OUString::createFromAscii("CDATA"),
::rtl::OUString::createFromAscii("http://openoffice.org/2000/text") );
aAttrList.AddAttribute(
::rtl::OUString::createFromAscii("office:class"),
::rtl::OUString::createFromAscii("CDATA"),
::rtl::OUString::createFromAscii("text") );
xHandler->startElement(
::rtl::OUString::createFromAscii("office:document"),
aAttrList );

// body element (no attributes)
aAttrList.clear();
xHandler->startElement(
::rtl::OUString::createFromAscii("office:body"),
aAtrList );

// paragraph element (no attributes)
aAttrList.clear();
xHandler->startElement(
::rtl::OUString::createFromAscii("text:p"),
aAtrList );

// write text
xHandler->characters(
::rtl::OUString::createFromAscii("Hello World!") );

// close paragraph !!!!!!! Error here ',' instead of ';' !!!!!
xHandler->startElement(
::rtl::OUString::createFromAscii("text:p"),

// close body
xHandler->endElement(
::rtl::OUString::createFromAscii("office:body") );

// close document element
xHandler->endElement(
::rtl::OUString::createFromAscii("office:document") );

// close document
xHandler->endDocument();
</code>

The first difficulty is with the instruction :
<code>[cpp]
// C++
SvXMLAttributeList aAttrList;
</code>
Why ? Because when writing a C++ automation program we haven't the SvXMLAttributeList type defined. Then we have to write it. I have take the corresponding code from OOo source code :
<OOB680_m5>/filter/source/xsltdialog (attributelist.hxx and the corresponding attributelist.cxx) but because the reader could not have downloaded the corresponding code, I provide it completely here.

== The AttributeList Class ==

First we provide the corresponding class :
<code>[cpp]
//Listing 10 AttributList class
// C++
struct AttributeList_Impl
{
AttributeList_Impl()
{
// performance improvement during adding
vecAttribute.reserve(20);
}
vector<struct TagAttribute_Impl> vecAttribute;
};

// From <OOB680_m5>/filter/source/xsltdialog/attributelist.hxx
class AttributeList : public WeakImplHelper1 < XAttributeList >
{
AttributeList_Impl *m_pImpl;
public:
AttributeList();
virtual ~AttributeList();

// methods that are not contained in any interface
void AddAttribute( const OUString &sName , const OUString &sType , const OUString &sValue );
void Clear();
void RemoveAttribute( const OUString sName );
void SetAttributeList( const Reference< XAttributeList > & );
void AppendAttributeList( const Reference< XAttributeList > & );

// ::com::sun::star::xml::sax::XAttributeList
virtual sal_Int16 SAL_CALL getLength(void)
throw( RuntimeException );
virtual OUString SAL_CALL getNameByIndex(sal_Int16 i)
throw( RuntimeException );
virtual OUString SAL_CALL getTypeByIndex(sal_Int16 i)
throw( RuntimeException );
virtual OUString SAL_CALL getTypeByName(const OUString& aName)
throw( RuntimeException );
virtual OUString SAL_CALL getValueByIndex(sal_Int16 i)
throw( RuntimeException );
virtual OUString SAL_CALL getValueByName(const OUString& aName)
throw( RuntimeException );

};
</code>

The complete implementation is :
<code>[cpp]
//Listing 11 AttributList class Implementation
// C++
//*************** AttributeList impementation
// from <OOB680_m5>/filter/source/xsltdialog/attributelist.hxx
sal_Int16 SAL_CALL AttributeList::getLength(void) throw( RuntimeException ){
return m_pImpl->vecAttribute.size();
}

OUString SAL_CALL AttributeList::getNameByIndex(sal_Int16 i) throw( RuntimeException ){
if( i < static_cast < sal_Int16 > (m_pImpl->vecAttribute.size()) ) {
return m_pImpl->vecAttribute[i].sName;
}
return OUString();
}

OUString SAL_CALL AttributeList::getTypeByIndex(sal_Int16 i) throw( RuntimeException ){
if( i < static_cast < sal_Int16 > (m_pImpl->vecAttribute.size() ) ) {
return m_pImpl->vecAttribute[i].sType;
}
return OUString();
}

OUString SAL_CALL AttributeList::getValueByIndex(sal_Int16 i) throw( RuntimeException ){
if( i < static_cast < sal_Int16 > (m_pImpl->vecAttribute.size() ) ) {
return m_pImpl->vecAttribute[i].sValue;
}
return OUString();
}

OUString SAL_CALL AttributeList::getTypeByName( const OUString& sName ) throw( RuntimeException ){
vector<struct TagAttribute_Impl>::iterator ii = m_pImpl->vecAttribute.begin();

for( ; ii != m_pImpl->vecAttribute.end() ; ii ++ ) {
if( (*ii).sName == sName ) {
return (*ii).sType;
}
}
return OUString();
}

OUString SAL_CALL AttributeList::getValueByName(const OUString& sName) throw( RuntimeException ){
vector<struct TagAttribute_Impl>::iterator ii = m_pImpl->vecAttribute.begin();

for( ; ii != m_pImpl->vecAttribute.end() ; ii ++ ) {
if( (*ii).sName == sName ) {
return (*ii).sValue;
}
}
return OUString();
}

AttributeList::AttributeList(){
m_pImpl = new AttributeList_Impl;
}

AttributeList::~AttributeList(){
delete m_pImpl;
}

void AttributeList::AddAttribute(const OUString &sName ,
const OUString &sType ,
const OUString &sValue ){
m_pImpl->vecAttribute.push_back( TagAttribute_Impl( sName , sType , sValue ) );
}

void AttributeList::Clear(){
m_pImpl->vecAttribute.clear();

OSL_ENSURE( ! getLength(), "Length > 0 after AttributeList::Clear!");
}

void AttributeList::RemoveAttribute( const OUString sName ){
vector<struct TagAttribute_Impl>::iterator ii = m_pImpl->vecAttribute.begin();

for( ; ii != m_pImpl->vecAttribute.end() ; ii ++ ) {
if( (*ii).sName == sName ) {
m_pImpl->vecAttribute.erase( ii );
break;
}
}
}

void AttributeList::SetAttributeList( const Reference< XAttributeList > &r ){
Clear();
AppendAttributeList( r );
}

void AttributeList::AppendAttributeList( const Reference< XAttributeList > &r ){
OSL_ENSURE( r.is(), "r isn't!" );

sal_Int32 nMax = r->getLength();
sal_Int32 nTotalSize = m_pImpl->vecAttribute.size() + nMax;
m_pImpl->vecAttribute.reserve( nTotalSize );

for( sal_Int16 i = 0 ; i < nMax ; i ++ ) {
m_pImpl->vecAttribute.push_back( TagAttribute_Impl(
r->getNameByIndex( i ) ,
r->getTypeByIndex( i ) ,
r->getValueByIndex( i )));
}
OSL_ENSURE( nTotalSize == getLength(), "nTotalSize != getLength()");
}
</code>

== The main Program ==

To make a complete automation program, we have to provide a main program.

<code>[cpp]
//Listing 12 The corrected Listing 9 program for automation.
// C++
int main( )
{
//retrieve an instance of the remote service manager
Reference< XMultiServiceFactory > rOfficeServiceManager;
rOfficeServiceManager = ooConnect();
OSL_ENSURE(rOfficeServiceManager.is(), "Unable to connected to the office\n");
//get the desktop service using createInstance returns an XInterface type
Reference< XInterface > Desktop = rOfficeServiceManager->createInstance(
OUString::createFromAscii( "com.sun.star.frame.Desktop" ));

//query for the XComponentLoader interface
Reference< XComponentLoader > rComponentLoader (Desktop, UNO_QUERY);
OSL_ENSURE(rComponentLoader.is() , "Unable to get XComponentloader service\n");

Reference< XDesktop > rDesktop(Desktop,UNO_QUERY);
OSL_ENSURE(rDesktop.is() , "Unable to get XDesktop service\n");

//get an instance of the OOowriter document
Reference< XComponent > xWriterComponent = rComponentLoader->loadComponentFromURL(
OUString::createFromAscii("private:factory/swriter"),
OUString::createFromAscii("_blank"),
0,
Sequence < ::com::sun::star::beans::PropertyValue >());

// instantiate the XML import component
OUString sService = OUString::createFromAscii("com.sun.star.comp.Writer.XMLImporter");
Reference<XDocumentHandler> xImport(
rOfficeServiceManager->createInstance(sService), UNO_QUERY );
OSL_ENSURE( xImport.is(), "can't instantiate XML import" );

// ******** These important lines where not in the original listing
// I find the clue in <OOB680_m5>/filter/source/xmlfilteradaptor/XmlFilterAdaptor.cxx
// #include <com/sun/star/document/XImporter.hpp> added in this file
// using namespace com::sun::star::document; added in this file
// com.sun.star.document.XImporter \ added in the MakeFile
Reference < XImporter > xImporter( xImport, UNO_QUERY );
xImporter->setTargetDocument ( xWriterComponent );

// OK. Now we have the import. Let's make a real simple document.

// a few comments:
// 1. We will use string constants from xmloff/xmlkywd.hxx
// 2. For convenience, we'll use a globally shared attribute list from the
// xmloff project (xmloff/attrlist.hxx)
// 3. In a real project, we would pre-construct our OUString, rather than use
// the slow createFromAscii(\x{2026}) method every time.

// We will write the following document: (the unavoidable 'Hello World!')
// <office:document
// office:class="text"
// xmlns:office="http://openoffice.org/2000/office"
// xmlns:text="http://openoffice.org/2000/text" >
// <office:body>
// <text:p>Hello World!</text:p>
// </office:body>
// </office:document>

xImport->startDocument();

// SvXMLAttributeList aAttrList; in http://xml.openoffice.org/filter/
// It is possible to find the corresponding code in source :
// <OOB680_m5>/filter/source/xsltdialog/attributelist.hxx and
// <OOB680_m5>/filter/source/xsltdialog/attributelist.cxx
AttributeList *xAttrList = new AttributeList();
Reference< XAttributeList > aAttrList = static_cast< XAttributeList* > ( xAttrList );

// our first element: first build up the attribute list, then start the element
// DON'T FORGET TO ADD THE NAMESPACES!

xAttrList->AddAttribute(
OUString::createFromAscii("xmlns:office"),
OUString::createFromAscii("CDATA"),
OUString::createFromAscii("http://openoffice.org/2000/office") );

xAttrList->AddAttribute(
OUString::createFromAscii("xmlns:text"),
OUString::createFromAscii("CDATA"),
OUString::createFromAscii("http://openoffice.org/2000/text") );
xAttrList->AddAttribute(
OUString::createFromAscii("office:class"),
OUString::createFromAscii("CDATA"),
OUString::createFromAscii("text") );

xImport->startElement(
OUString::createFromAscii("office:document"),
aAttrList );

// body element (no attributes)
aAttrList.clear();
xImport->startElement(
OUString::createFromAscii("office:body"),
aAttrList );

// paragraph element (no attributes)
aAttrList.clear();
xImport->startElement(
OUString::createFromAscii("text:p"),
aAttrList );

// write text
xImport->characters(
OUString::createFromAscii("Hello World!") );

// close paragraph
xImport->endElement(
OUString::createFromAscii("text:p") );

// close body
xImport->endElement(
OUString::createFromAscii("office:body") );

// close document element
xImport->endElement(
OUString::createFromAscii("office:document") );

// close document
xImport->endDocument();

return 0;
}
</code>

It's easy to find the program [[UNO_automation_with_a_binary_%28executable%29#Preparing_a_new_Code_as_a_starting_Point|ooConnect()]] in this document.

[[Category:Filter]]

PowerPoint filter

2007-11-01T18:28:16Z

Hub:

PowerPoint filter

2007-11-01T18:27:28Z

Hub:

The PowerPoint filter is in charge of import and export of PowerPoint binary document (.PPT) into [[Impress]]. If you are a looking for the PPTX files from PowerPoint 2007, please go to the [[Office Open XML]].

The [[PowerPoint filter]] is maintained by [[User:Sj|Sven Jacobi]].

== Import ==

The import code is scattered between the svx and sd modules.
Relevant files are in:
* sd/source/filter/ppt
* svx/source/svdraw/svdfppt.cxx

== Export ==

The export code is contained in sd/source/filter/eppt

[[Category:Impress]]
[[Category:Filter]]

Office Open XML/Legacy Implementation

2007-11-01T18:26:27Z

Hub: /* OO.o Implementation */

= OOXML Basics =

"Office Open XML" is an XML based file format that has been published as [http://www.ecma-international.org/publications/standards/Ecma-376.htm ECMA-376]. It is used as default file format by Microsoft Office 2007.

There are plans to support this file format in OpenOffice.org for interoperation with Microsoft Office 2007.

There are 3 major types of formats

* [[WordprocessingML]] - For word processor documents (file extensions may be docx, docm)
* [[SpreadsheetML]] - For spreadsheet documents (file extensions may be xlsx, xlsm)
* [[PresentationML]] - For presentation documents (file extensions may be pptx, pptm)
* [[DrawingML]] - Used by other markup language to represent graphics data.
* [[VML]] - A legacy vector markup.

== Packaging Conventions ==
OpenXML document is a package that consists of a flat collection of '''"parts"'''. Each "part" has a case-''insensitive'' part name that consists of a slash (/) delimited sequence of segment names such as "/pres/slides/slide1.xml".

For the most part, the ZIP compression is used to package the parts, in which case the term '''"package"''' refers to the ZIP archive, and the parts refer to the individual files archived within. The part name in this case is the file path within the archive.

Each part also has a '''content type''', and '''/[Content_Types].xml''' provides the content type of each part within the archive.

== Relationships ==
Packages and parts can contains '''explicit relationships''' to other parts as well as to external resources. Every explicit relationship has an ID and a type, and relationship types are named using URIs.

The set of explicit relationships for each package or part is stored in a relationship part whose name (or path) follows a specific convention e.g. the relationship part for a part called '''"/a/b/c.xml"''' is called '''"/a/b/_rels/c.xml.rels"'''. As a special case, the relationship part for the package as a whole is called '''"/_rels/.rels"'''.

= OO.o Implementation =
There is some code in the oox module ([[OOX]]) from the [[Xml]] project. The [[CWS]] is xmlfilter02 in SRC680. ([http://eis.services.openoffice.org/EIS2/cws.ShowCWS?Path=SRC680%2Fxmlfilter02 view the workspace on EIS])

To fetch the oox code from CVS (using CVS_ROOT is set properly):

cvs co -r cws_src680_xmlfilter02 -d oox xml/oox

One important note: we use the term '''fragment''' in the name of our source files to correspond with what the standard calls '''part'''. For instance, the source file that contains class definition that handles the workbook part in [[SpreadsheetML]] is called workbookfragment.cxx. This convention is prevalent across all application types within [[oox]] module.

Bonsai is also convenient to follow the changes:

[http://bonsai.go-oo.org/cvsquery.cgi?treeid=default&module=all&branch=cws_src680_xmlfilter02&branchtype=match&dir=xml%2Foox&file=&filetype=match&who=&whotype=match&sortby=Date&hours=2&date=week&mindate=&maxdate=&cvsroot=%2Fhome%2Fooweb%2Fcvsup the changes done in the last 2 weeks]

Word document import is in the [[WriterFilter|writerfilter]] module.

== Implementation Generalities ==

The whole [[OOX]] filter makes use of the new [[FastParser]] service to implement an event driven [[SAX]] parser.

== Various Resources ==

* http://blogs.sun.com/GullFOSS/entry/office_open_xml_import_filter
* [http://eis.services.openoffice.org/EIS2/cws.ShowCWS?Path=SRC680%2Fxmlfilter02 CWS on EIS]
* [http://www.ecma-international.org/publications/standards/Ecma-376.htm ECMA published standard]
* [http://www.ecma-international.org/news/TC45_current_work/TC45_available_docs.htm Ecma Office Open XML File Formats Standard]
* [http://blogs.msdn.com/brian_jones/archive/2005/06/20/430892.aspx Brian Jones introduction to the Office 12 File Format]

[[Category:Filter]]
[[Category:Office Open XML]]

FastParser

2007-11-01T18:24:45Z

Hub:

DRAFT

= Abstract =

The service ''com.sun.star.xml.sax.FastParser'' provides an xml parser that generates sax like events
by implementing a [[XFastParser]]

= IDL =

<pre>
service : XFastParser;
</pre>

= Namespace =

com::sun::star::xml::sax

= Motivation =

For implementing the first OOo xml filters in 2000 we decided to use a sax api to parse the
xml streams. At this time there where some already proven sax implementations we could
choose from. We decided to use the [http://expat.sourceforge.net expat - XML Parser Toolkit].
Under the namespace ''com.sun.star.xml.sax'' we developed a set of [[UNO]] interfaces that assembled
a sax api interface. A component was implemented that used expat to implement a reader and
a writer. This component is used in the [[XMLOFF]] project that implements the import and export
filter for the [[OpenDocumentFormat]].

This solution has two drawbacks:

* The initial sax api didn't know about xml namespaces, so namespaces have to be handled in each filter.
* The utf8 strings from the xml stream have to be converted to the UNO strings that use utf16 for encoding. This is one of the major bottlenecks when dealing with larger xml documents.

An additional feature that is not provided by the sax api is the concept of import contexts.
Usually a sax import filter implements one document handler that gets all xml events for the whole
xml stream. Therefor this document handler must know about all valid elements. In the [[XMLOFF]]
project we added a context stack to the document handler.
Basically, we added a ''create child event'' to the existing sax
events. This event was called on the current context to create a new child context for each
direct child element of the current context. When the child element was processed its context
would be put on top of the stack and became the current. After the current context gets the
end event it is removed from the stack.
This made implementing an importer for a rather complex format very easy.

<p>The problem is that the namespace handling and the context feature is buried deep in the [[XMLOFF]]
project. So new filter implementations would have to reimplement it.</p>

<p>
To simplify implementations of xml import filters I designed a new sax like UNO api that
implements the following key features:
* Support for namespaces
* Support for the context feature
* Replacing xml names strings with integer tokens
</p>

<p>
The last feature, replacing xml names with integer tokens, should overcome the string performance
issue we had with the old sax api. It also simplifies the implementation of an xml import filter.
</p>

<p>For example consider the following code from [[XMLOFF]]
<pre>

void AnimationNodeContext::StartElement( const Reference< XAttributeList >& xAttrList )
{
for( sal_Int16 nAttribute = 0; nAttribute < nCount; nAttribute++ )
{
const OUString& rAttrName = xAttrList->getNameByIndex( nAttribute );
const OUString& rValue = xAttrList->getValueByIndex( nAttribute );

OUString aLocalName;
sal_uInt16 nPrefix = GetImport().GetNamespaceMap().GetKeyByAttrName( rAttrName, &aLocalName );

if( IsXMLToken( aLocalName, XML_PAR ) && nPrefix == XML_NAMESPACE_ANIMATION )
{
...
}
else if( IsXMLToken( aLocalName, XML_NODE ) && nPrefix == XML_NAMESPACE_SMIL ) )
{
...
}
}
}
</pre>

This contains multiple string conversions, namespace lookups and string compares.</p>

<p>With the fast sax parser api this would look like this

<pre>

void AnimationNodeContext::startFastElement( sal_Int32 Element, const Reference< XFastAttributeList >& Attribs )
{
switch( Element )
{
case NMSP_ANIMATION|XML_PAR:
...
break;
case NMSP_SMIL|XML_NODE:
...
break;
}
}
</pre>
</p>

= Implementing an xml format import filter with the fast sax api =

To parse an xml stream you need to create an instance of the service ''com.sun.star.xml.sax.FastParser''.
This parser needs a [[XFastDocumentHandler]] that you must set via the method ''setFastDocumentHandler()''.
This [[XFastDocumentHandler]] must be implemented by your filter component. The important method of the [[XFastDocumentHandler]]
is ''createFastChildContext()'' from its parent interface [[XFastContextHandler]]. It is called from the parser
to create a context for the root element of the xml stream.

== The fast context handler ==

<p>When the [[XFastDocumentHandler]] returns a [[XFastContextHandler]] for the root element to the parser,
the parser uses that context to send him the sax events for the root element.</p>

<p>For each child element of an xml element its context is also asked by the parser to return a context
for the child element. The returned context then gets all sax events for that element.</p>

<p>A filter can return the same instance of a [[XFastContextHandler]] more than once.</p>

<p>Since the [[XFastDocumentHandler]] interface is derived from [[XFastContextHandler]] you can implement a filter
with only one instance by always returning your [[XFastDocumentHandler]] as a child context. This way you disable
the context feature and you get the sax events the same way as with an old sax api XDocumentHandler.</p>

== The fast token handler ==

<p>You should implement an object with the interface [[XFastTokenHandler]]. It is used by
the parser to convert xml element local names and attribute names to integer tokens. Usually the parser will
retrieve integer tokens by calling ''getTokenFromUTF8''. This method takes an uft8 encoded string as a byte sequence.
Since xml files are usually encoded in utf8, no format conversion is needed in the default case.</p>

<p>When the parser processes an xml element it first asks the token handler if he has a valid integer token for the
local name of that element.
If the token handler does not know the element local name the parser handles this element as an unknown element.
Elements with a namespace that was not registered at the parser are also handled as unknown elements, even if the
local name is known by the token handler.</p>

=== Optimize your fast token handler ===

<p>For maximum performance the fast token handler should know all valid element and attribute names. You can also add
common attribute values. It is very easy to automatically generate such a token handler.</p>

<p>For the ms office 12 import filter I used [http://www.gnu.org/software/gperf/gperf.html gperf] to create a perfect hash
for all xml names of that format at compile time. See [[XFastTokenHandler]] for a sample implementation.</p>

== Pseudo code to parse an xml stream ==

<pre>
// namespace id must be < 0x10000
const sal_Int32 NMSP_SAMPLE_1 = (1 << 16);
const sal_Int32 NMSP_SAMPLE_2 = (2 << 16);

class MyContext : public XFastContextHandler
{
// XFastContextHandler
void startFastElement( sal_Int32 Element, const Reference< XFastAttributeList >& Attribs )
{
if( Element == NMSP_SAMPLE_1|XML_sampleelement )
{
maName = Attribs->getOptionalValue[NMSP_SAMPLE_2|XML_name];
}
}

void endFastElement( sal_Int32 Element ) {}

void startUnknownElement( const OUString& Namespace, const OUString& Name, const Reference< XFastAttributeList >& Attribs ) {}
void endUnknownElement( const OUString& Namespace, const OUString& Name ) {}

Reference< XFastContextHandler > createFastChildContext( sal_Int32 Element, const Reference< XFastAttributeList >& Attribs )
{
if( Element == NMSP_SAMPLE_1|XML_sampleelement )
return this;
else
return 0;
}

Reference< XFastContextHandler > createUnknownChildContext( const OUString& Namespace, const OUString& Name, const Reference< XFastAttributeList >& Attribs )
{
return 0;
}

void characters( const OUString& aChars ) {}
};

class MyHandler : public XFastDocumentHandler
{
// XFastDocumentHandler
void startDocument()
{
// parsing one xml file is started
}

void endDocument()
{
// parsing one xml file is finished
}

void SAL_CALL setDocumentLocator( const Reference< XLocator >& xLocator ) {}

// XFastContextHandler
void startFastElement( sal_Int32 Element, const Reference< XFastAttributeList >& Attribs )
{
}

void startUnknownElement( const OUString& Namespace, const OUString& Name, const Reference< XFastAttributeList >& Attribs )
{
}

void endFastElement( sal_Int32 Element )
{
}

void endUnknownElement( const OUString& Namespace, const OUString& Name )
{
}

Reference< XFastContextHandler > createFastChildContext( sal_Int32 Element, const Reference< XFastAttributeList >& Attribs )
{
if( Element == NMSP_SAMPLE_1|XML_sampleelement )
{
return new MyContext; // pipe sax events for this element to my context
}
return 0; // ignore sax events for this element and all child elements
}

Reference< XFastContextHandler > createUnknownChildContext( const OUString& Namespace, const OUString& Name, const Reference< XFastAttributeList >& Attribs )
{
// this is called for elements with an unknown namespace or elements which are unknown to the token handler
// so in general they can be ignored as we don't know anything about them
return 0;
}

void characters( const OUString& aChars ) {}
};

void parse( const Reference< XInputStream >& xInputStream, OUString& sSystemId )
{
xml::sax::InputSource aParserInput;
aParserInput.sSystemId = rFragmentPath;
aParserInput.aInputStream = sSystemId

Reference< XFastDocumentHandler > xHandler( new MyHandler );

// can be reused for multiple xml file parsings
// see xmlfilter02/oox/source/token for possible implementation
Reference< XFastTokenHandler > xTokenHandler( new MyTokenHandler );

Reference< XFastParser > xParser( mxServiceFactory->createInstance( "com.sun.star.xml.sax.FastParser", UNO_QUERY_THROW ) );
xParser->setFastDocumentHandler( xHandler );
xParser->setTokenHandler( xTokenHandler );
xParser->registerNamespace( "http://sample_namespace_1", NMSP_SAMPLE_1 );
xParser->registerNamespace( "http://sample_namespace_2", NMSP_SAMPLE_2 );
xParser->parseStream( aParserInput );
}

</pre>

= Migration for [[XMLOFF]] project =

Since the current major performance bottleneck of the filters inside the [[XMLOFF]] project is the string handling,
a migration of the filters to the fast sax api should be considered. As this project is already a huge one, a migration
where the code is adapted in small pieces may be advisable.

In the first step the class ''SvXMLImport'' must be rewritten to use the new sax parser api.
The SvXMLImportContext would be derived from the [[XFastContextHandler]] interface. The base implementation of its
method could call the old sax methods. Therefore all derivations from SvXMLImportContext that do not excplicitly
override the methods from [[XFastContextHandler]] will still work as before until someone migrate them to the new
api.

''todo, write more details''

= Todo List =

== Design an interface for an xml writer using tokens ==

The current solution only allows implementing an xml import filter. A writer component and interfaces would be needed to also support export filters.

== Implement a connecter that feeds a [[XFastDocumentContext]] ==

There are already some implementations that do not use xml streams but feed the old sax api directly.
It is very easy to add the old ''com.sun.star.xml.sax.XDocumentHandler'' interface to the FastParser
service. This would allow that a filter implemented with the new fast sax api can be feed with events
by a component using the old sax api.

[[Category:Filter]]

Building with ooobuild

2007-11-01T04:13:24Z

Hub: /* get the source */

== Vanilla Up-stream builds ==

See the [http://tools.openoffice.org#Build tools] project for build guides for various platforms.

Also for OS/X see [[MacOSXBuildInstructions]]

For GNU/Linux Sparc, with gcc4.1 & gcj, see [[GNULinuxSparcPorting]]

== ooo-build builds ==

<center>
'''If you are looking for additional building tips for Windows check [[Windows |this]] page first.'''
</center>
----
<br>

=== get the source ===

You need to checkout the source code using SVN:

svn checkout http://svn.gnome.org/svn/ooo-build/trunk ooo-build

=== configure ===

<p>
The build process is pretty complicated; you have a choice
of commands now; although running both won't actually hurt:
</p>
./autogen.sh --with-distro=<b>HelloMum</b> # only for the CVS version
./configure --with-distro=<b>HelloMum</b> # the packaged version

<p>
This will guess which branch snapshot you want to build; if
you have other ideas use the --with-tag option; eg.
<code>--with-tag=src680-m65</code> for a legacy branch.
</p>
<p>
NB. getting your distro right is quite important; values like
SUSE-10.1 (also SLED10), UbuntuDapper, DebianEtch64 may float
your boat. Checkout <code>ls distro-configs</code> to see more.
</p>
<p>
If for some reason you have a 31337 multi-threaded computer,
with great slabs of RAM; you'll want to use --with-num-cpus=8
etc. NB. it's not clever to force the build to swap like a
demented pawnbroker by using an artificially high number; C++
compilation is seriously memory hungry.
</p>
<p>
In particular, building SRC680 requires a recent jdk & a
version of apache-ant. If you use a Novell system, just do:
<code>sudo rug in apache-ant</code>, alternatively download
a package from [http://www.rpmfind.net/linux/rpm2html/search.php?query=apache-ant&submit=Search+..." rpmfind.net] or failing that see [http://ant.apache.org/bindownload.cgi Ant download]
& set the ANT environment variable
appropriately before configuring.
</p>
<h4>Known ./configure parameters</h4>
<ul>
<li><h5>up-stream options</h5><p> - all options are passed through directly
to the internal configure, so they should work nicely here too.</p>
</li>
<li><h5><code>--with-system-<package name></code></h5>
<p>where <package name> is replaced by the package to use. I don't
have a particularly good understanding of its full effects beyond
the fact that it (probably) doesn't then build its own copy of the
package.</p>
<p><b>Examples:</b><br>
<code>--with-system-python</code><br>
<code>--with-system-mozilla</code><br>
<code>--with-system-gcc</code><br>
<code>--with-system-neon</code><br>
<code>--with-system-curl</code><br>
</p>
</li>
<li><h5><code>--without-system-<package name></code></h5>
<p><b>Examples:</b><br>
<code>--without-system-mozilla</code>
</p>
</li>
<li><h5><code>--with-<package or tag>[=value]</code></h5>
<p><b>Examples:</b><br>
<code>--with-lang=en-US</code><br>
<code>--with-build-version="Build 2.0.1.3"</code><br>
<code>--with-distro=Gentoo</code><br>
</p>
</li>
<li><h5><code>--without-<package or tag></code></h5>
<p><b>Examples:</b><br>
<code>--without-myspell-dicts</code><br>
<code>--without-java</code><br>
<code>--without-nas</code><br>
</p>
</li>
<li><h5><code>--enable-<package name></code></h5>
<p><b>Examples:</b><br>
<code>--enable-openldap</code><br>
</p>
</li>
<li><h5><code>--disable-<package name></code></h5>
<p><b>Examples:</b><br>
<code>--disable-openldap</code><br>
<code>--disable-qadevoo</code><br>
<code>--disable-mozilla</code><br>
<code>--disable-access</code><br>
<code>--disable-evolution2</code><br>
</p>
</li>
<li><h5><code>--mandir=<dir></code></h5></li>
</ul>

=== Requirements ===

*A recent version of automake, such as the 1.9 series.
*If you don't have a working Java VM (i.e. any runtime), you should pass <code>--with-java=no</code> to either <code>autogen.sh</code> or <code>configure</code>.
*You need the Archive/Zip module for Perl (perl-Archive-Zip on RPM-based distributions, libarchive-zip-perl on dpkg-based distributions). Alternatively, see instructions[http://ooo.ximian.com/cpan.html] for obtaining Perl modules through CPAN.
*You need the development package for Python (this would be python-devel on RPM-based distributions).
*You need curl and curl-devel.
*You need odbc_config to be present. On SUSE systems, this is in the unixODBC-devel package.
*You need libsndfile and libsndfile-devel.
*If you don't have a recent enough openldap, pass <code>--disable-openldap</code> to <code>autogen.sh</code> or <code>configure</code>.
*You need neon and neon-devel.
*You need qt3 and qt3-devel, or if you don't have the KDE development packages, pass <code>--disable-kde</code> to <code>autogen.sh</code> or <code>configure</code>.
*You need mozilla-nss-devel.
*In SuSE, you need gecko-sdk, mono-devel and cups-devel

=== download ===

<p>
By the time you've upgraded your system to the point that it
has all the packages you need to start building OO.o (mozilla etc. etc.) you're almost at the point that you
can download the bulk of the source. To do this, after a
successful configure simply type: <code>./download</code> and wait.
</p>
<p>
If for whatever reason this fails, you can verify your download
by fetching the equivalent .md5 file & comparing it to
the result of <code>md5sum <archive></code>. The source
archives are http://download.go-oo.org/SRC680
- put the source in ooo-build/src.
</p>

=== make ===

<p>
This is the taxing bit - type <code>make</code> and don't forget
to press enter. Quite possibly you want to log the output, so
why not <code>make 2>&1 | tee /tmp/log</code>.
</p>
<p>
Since ooo-build wraps the actual OO.o configuration &
build process, there are a number of internal config checks that
also need to pass. For a first time build it's well worth staying
near the console while everything unpacks, and the internal
configure runs; if that completes without incident - you're
usually into the heavy-duty thumb twiddling.
</p>

== See also ==

*[[Installing]]
*[[Tinderbox Setup]]
*[[BuildSpeedup]]
*[[OpenSUSE Build Instructions]]
*[[SUSE9.3 Build Instructions]]
*[[Ubuntu Build Instructions]]
*OpenOffice.org "Tools" page [http://tools.openoffice.org/dev_docs/build_linux.html]
*[[Build Tool Requirements]]
*[[O3-build|O3 Build]], an ISO image containing all the required software to build OOo on Linux.

[[Category: Development]]

Building with ooobuild

2007-11-01T04:12:55Z

Hub: update instructions

== Vanilla Up-stream builds ==

See the [http://tools.openoffice.org#Build tools] project for build guides for various platforms.

Also for OS/X see [[MacOSXBuildInstructions]]

For GNU/Linux Sparc, with gcc4.1 & gcj, see [[GNULinuxSparcPorting]]

== ooo-build builds ==

<center>
'''If you are looking for additional building tips for Windows check [[Windows |this]] page first.'''
</center>
----
<br>

=== get the source ===

You need to checkout the source code using SVN:

$ svn checkout http://svn.gnome.org/svn/ooo-build/trunk ooo-build

=== configure ===

<p>
The build process is pretty complicated; you have a choice
of commands now; although running both won't actually hurt:
</p>
./autogen.sh --with-distro=<b>HelloMum</b> # only for the CVS version
./configure --with-distro=<b>HelloMum</b> # the packaged version

<p>
This will guess which branch snapshot you want to build; if
you have other ideas use the --with-tag option; eg.
<code>--with-tag=src680-m65</code> for a legacy branch.
</p>
<p>
NB. getting your distro right is quite important; values like
SUSE-10.1 (also SLED10), UbuntuDapper, DebianEtch64 may float
your boat. Checkout <code>ls distro-configs</code> to see more.
</p>
<p>
If for some reason you have a 31337 multi-threaded computer,
with great slabs of RAM; you'll want to use --with-num-cpus=8
etc. NB. it's not clever to force the build to swap like a
demented pawnbroker by using an artificially high number; C++
compilation is seriously memory hungry.
</p>
<p>
In particular, building SRC680 requires a recent jdk & a
version of apache-ant. If you use a Novell system, just do:
<code>sudo rug in apache-ant</code>, alternatively download
a package from [http://www.rpmfind.net/linux/rpm2html/search.php?query=apache-ant&submit=Search+..." rpmfind.net] or failing that see [http://ant.apache.org/bindownload.cgi Ant download]
& set the ANT environment variable
appropriately before configuring.
</p>
<h4>Known ./configure parameters</h4>
<ul>
<li><h5>up-stream options</h5><p> - all options are passed through directly
to the internal configure, so they should work nicely here too.</p>
</li>
<li><h5><code>--with-system-<package name></code></h5>
<p>where <package name> is replaced by the package to use. I don't
have a particularly good understanding of its full effects beyond
the fact that it (probably) doesn't then build its own copy of the
package.</p>
<p><b>Examples:</b><br>
<code>--with-system-python</code><br>
<code>--with-system-mozilla</code><br>
<code>--with-system-gcc</code><br>
<code>--with-system-neon</code><br>
<code>--with-system-curl</code><br>
</p>
</li>
<li><h5><code>--without-system-<package name></code></h5>
<p><b>Examples:</b><br>
<code>--without-system-mozilla</code>
</p>
</li>
<li><h5><code>--with-<package or tag>[=value]</code></h5>
<p><b>Examples:</b><br>
<code>--with-lang=en-US</code><br>
<code>--with-build-version="Build 2.0.1.3"</code><br>
<code>--with-distro=Gentoo</code><br>
</p>
</li>
<li><h5><code>--without-<package or tag></code></h5>
<p><b>Examples:</b><br>
<code>--without-myspell-dicts</code><br>
<code>--without-java</code><br>
<code>--without-nas</code><br>
</p>
</li>
<li><h5><code>--enable-<package name></code></h5>
<p><b>Examples:</b><br>
<code>--enable-openldap</code><br>
</p>
</li>
<li><h5><code>--disable-<package name></code></h5>
<p><b>Examples:</b><br>
<code>--disable-openldap</code><br>
<code>--disable-qadevoo</code><br>
<code>--disable-mozilla</code><br>
<code>--disable-access</code><br>
<code>--disable-evolution2</code><br>
</p>
</li>
<li><h5><code>--mandir=<dir></code></h5></li>
</ul>

=== Requirements ===

*A recent version of automake, such as the 1.9 series.
*If you don't have a working Java VM (i.e. any runtime), you should pass <code>--with-java=no</code> to either <code>autogen.sh</code> or <code>configure</code>.
*You need the Archive/Zip module for Perl (perl-Archive-Zip on RPM-based distributions, libarchive-zip-perl on dpkg-based distributions). Alternatively, see instructions[http://ooo.ximian.com/cpan.html] for obtaining Perl modules through CPAN.
*You need the development package for Python (this would be python-devel on RPM-based distributions).
*You need curl and curl-devel.
*You need odbc_config to be present. On SUSE systems, this is in the unixODBC-devel package.
*You need libsndfile and libsndfile-devel.
*If you don't have a recent enough openldap, pass <code>--disable-openldap</code> to <code>autogen.sh</code> or <code>configure</code>.
*You need neon and neon-devel.
*You need qt3 and qt3-devel, or if you don't have the KDE development packages, pass <code>--disable-kde</code> to <code>autogen.sh</code> or <code>configure</code>.
*You need mozilla-nss-devel.
*In SuSE, you need gecko-sdk, mono-devel and cups-devel

=== download ===

<p>
By the time you've upgraded your system to the point that it
has all the packages you need to start building OO.o (mozilla etc. etc.) you're almost at the point that you
can download the bulk of the source. To do this, after a
successful configure simply type: <code>./download</code> and wait.
</p>
<p>
If for whatever reason this fails, you can verify your download
by fetching the equivalent .md5 file & comparing it to
the result of <code>md5sum <archive></code>. The source
archives are http://download.go-oo.org/SRC680
- put the source in ooo-build/src.
</p>

=== make ===

<p>
This is the taxing bit - type <code>make</code> and don't forget
to press enter. Quite possibly you want to log the output, so
why not <code>make 2>&1 | tee /tmp/log</code>.
</p>
<p>
Since ooo-build wraps the actual OO.o configuration &
build process, there are a number of internal config checks that
also need to pass. For a first time build it's well worth staying
near the console while everything unpacks, and the internal
configure runs; if that completes without incident - you're
usually into the heavy-duty thumb twiddling.
</p>

== See also ==

*[[Installing]]
*[[Tinderbox Setup]]
*[[BuildSpeedup]]
*[[OpenSUSE Build Instructions]]
*[[SUSE9.3 Build Instructions]]
*[[Ubuntu Build Instructions]]
*OpenOffice.org "Tools" page [http://tools.openoffice.org/dev_docs/build_linux.html]
*[[Build Tool Requirements]]
*[[O3-build|O3 Build]], an ISO image containing all the required software to build OOo on Linux.

[[Category: Development]]

WriterFilter

2007-10-26T20:06:27Z

Hub: /* Dump OOXML tokens */

== Download Install Sets for Current Milestone ==

We provide downloads for the current milestone (Solaris SPARC, Linux and Windows) here:

http://ooo.services.openoffice.org/pub/OpenOffice.org/cws/upload/writerfilter2/

== Getting Current Source Code for WriterFilter ==

WriterFilter is currently not included in the build system. You have to check it out manually:
<pre>
cvs -d:pserver:anoncvs@anoncvs.services.openoffice.org:/cvs co sw/writerfilter
</pre>

== Installing WriterFilter ==

=== Prerequisites ===

The current [[CWS]] for WriterFilter is <code>xmlfilter02</code>. It previously was in <code>writerfilter2</code>. Have a look in [[EIS]] for details on the CWS.

You will need an installed StarOffice/OOo and the following projects:
* comphelper
* filter
* jurt
* offapi
* offuh
* scp2
* svtools
* svx
* sw

Compile these projects and deliver the libraries to your installation in <code><SOINST></code>.

=== Changing Filter Detection ===

In
<code><SOINST>/share/registry/modules/org/openoffice/TypeDetection/Filter/fcfg_writer_filters.xcu</code>
add node with attribute <code>oor:name="MS Word 97"</code>:
<pre>
<node oor:name="MS Word 97" oor:op="replace">
<prop oor:name="Flags"><value>IMPORT EXPORT ALIEN 3RDPARTYFILTER</value></prop>
<prop oor:name="UIComponent"/>
<prop oor:name="FilterService"><value>com.sun.star.comp.Writer.WriterFilter</value></prop>
<prop oor:name="UserData"><value>CWW8</value></prop>
<prop oor:name="UIName">
<value xml:lang="x-default">Microsoft Word 97/2000/XP (new)</value>
</prop>
<prop oor:name="FileFormatVersion"><value>0</value></prop>
<prop oor:name="Type"><value>writer_MS_Word_97</value></prop>
<prop oor:name="TemplateName"/>
<prop oor:name="DocumentService"><value>com.sun.star.text.TextDocument</value></prop>
</node>
</pre>
Remember to grant yourself write access to the xcu.

=== Create Resource Database for New Intefaces ===

Note: This is only necessary if you do not use CWS xmlfilter02.

Generate resource database for new interfaces: In <code>offapi/<platform>/ucr/com/sun/star/text</code> call
<pre>regmerge /tmp/merge.rdb -UCR XTextAppend.urd</pre>

=== Register New Interfaces ===

Note: Again, only necessary if not using the CWS xmlfilter02

In <code><SOINST>/program</code> call
<pre>
./unopkg add /tmp/merge.rdb
</pre>

=== Register filter component ===

In <code><SOINST>/program</code> call
<pre>
chmod u+w services.rdb
regcomp -register -r services.rdb -c <writerfilter lib>
</pre>

Now, if you load a file recognized as "Word 97", WriterFilter will be used.

== Documentation ==

* Documentation generated by Doxygen (will be available soon)

== Debug tokenizers ==

You will need an installation of OpenOffice.org with the libraries from writerfilter delivered into the $SOINST/program directory.

=== Dump WW8 tokens ===

<pre>
$SOINST/program/uno -l libwriterfilter.uno.so -c debugservices.doctok.ScannerTestService -- file://...
</pre>

=== Dump WordprocessingML tokens ===

<pre>
$SOINST/program/uno -l libwriterfilter.uno.so -c debugservices.ooxml.ScannerTestService -- file://...
</pre>

== Notes ==

The properties of sprm 0x6a03 (sprmCPicLocation) have to be resolved. Otherwise the FC of the picture to come is not stored.

[[Category:Filter]]
[[Category:Office Open XML]]
[[Category:Source directories]]

WriterFilter

2007-10-26T16:43:59Z

Hub:

== Download Install Sets for Current Milestone ==

We provide downloads for the current milestone (Solaris SPARC, Linux and Windows) here:

http://ooo.services.openoffice.org/pub/OpenOffice.org/cws/upload/writerfilter2/

== Getting Current Source Code for WriterFilter ==

WriterFilter is currently not included in the build system. You have to check it out manually:
<pre>
cvs -d:pserver:anoncvs@anoncvs.services.openoffice.org:/cvs co sw/writerfilter
</pre>

== Installing WriterFilter ==

=== Prerequisites ===

The current [[CWS]] for WriterFilter is <code>xmlfilter02</code>. It previously was in <code>writerfilter2</code>. Have a look in [[EIS]] for details on the CWS.

You will need an installed StarOffice/OOo and the following projects:
* comphelper
* filter
* jurt
* offapi
* offuh
* scp2
* svtools
* svx
* sw

Compile these projects and deliver the libraries to your installation in <code><SOINST></code>.

=== Changing Filter Detection ===

In
<code><SOINST>/share/registry/modules/org/openoffice/TypeDetection/Filter/fcfg_writer_filters.xcu</code>
add node with attribute <code>oor:name="MS Word 97"</code>:
<pre>
<node oor:name="MS Word 97" oor:op="replace">
<prop oor:name="Flags"><value>IMPORT EXPORT ALIEN 3RDPARTYFILTER</value></prop>
<prop oor:name="UIComponent"/>
<prop oor:name="FilterService"><value>com.sun.star.comp.Writer.WriterFilter</value></prop>
<prop oor:name="UserData"><value>CWW8</value></prop>
<prop oor:name="UIName">
<value xml:lang="x-default">Microsoft Word 97/2000/XP (new)</value>
</prop>
<prop oor:name="FileFormatVersion"><value>0</value></prop>
<prop oor:name="Type"><value>writer_MS_Word_97</value></prop>
<prop oor:name="TemplateName"/>
<prop oor:name="DocumentService"><value>com.sun.star.text.TextDocument</value></prop>
</node>
</pre>
Remember to grant yourself write access to the xcu.

=== Create Resource Database for New Intefaces ===

Note: This is only necessary if you do not use CWS xmlfilter02.

Generate resource database for new interfaces: In <code>offapi/<platform>/ucr/com/sun/star/text</code> call
<pre>regmerge /tmp/merge.rdb -UCR XTextAppend.urd</pre>

=== Register New Interfaces ===

Note: Again, only necessary if not using the CWS xmlfilter02

In <code><SOINST>/program</code> call
<pre>
./unopkg add /tmp/merge.rdb
</pre>

=== Register filter component ===

In <code><SOINST>/program</code> call
<pre>
chmod u+w services.rdb
regcomp -register -r services.rdb -c <writerfilter lib>
</pre>

Now, if you load a file recognized as "Word 97", WriterFilter will be used.

== Documentation ==

* Documentation generated by Doxygen (will be available soon)

== Debug tokenizers ==

You will need an installation of OpenOffice.org with the libraries from writerfilter delivered into the $SOINST/program directory.

=== Dump WW8 tokens ===

<pre>
$SOINST/program/uno -l libwriterfilter.uno.so -c debugservices.doctok.ScannerTestService -- file://...
</pre>

=== Dump OOXML tokens ===

<pre>
$SOINST/program/uno -l libwriterfilter.uno.so -c debugservices.ooxml.ScannerTestService -- file://...
</pre>

== Notes ==

The properties of sprm 0x6a03 (sprmCPicLocation) have to be resolved. Otherwise the FC of the picture to come is not stored.

[[Category:Filter]]
[[Category:Office Open XML]]
[[Category:Source directories]]

Oox

2007-10-26T16:43:15Z

Hub:

Stands for [[Office Open XML]]. The name of the module that handle [[Office Open XML]] import. Part of the [[Xml]] project.

= Note =

The [[WordprocessingML]] importer is part of a different effort in writerfilter2 where the refactoring of the binary and RTF filter also takes place.

= Directory Structure =
== core ==
This directory includes common code for all filters.

=== AttributeList (class) ===
Provides access to attribute values of an element. '''AttributeList''' wraps a ''com.sun.star.xml.sax.XFastAttributeList'' object, and provides convenience functions that convert the string value of an attribute to various other data types. This class is usually used as a local variable declared with an instance of [[XFastAttributeList]] passed from the [[FastParser]] instance.

=== FragmentHandler (class) ===
Top-most parent class that handles fragments. In most cases this class handles all nested contexts for increased performance. This class implements [[XFastDocumentHandler]] interface.

=== RelationsFragmentHandler (class) ===
Handles loading of relationships fragments ( '''/*/_rels/*.rels''' ). Like the FragmentHandler class, this class also implements [[XFastDocumentHandler]] interface.

=== ImportBase (class) ===
The base class for application specific import filters, currently sub-classed by '''oox::ppt::PowerPointImport''' and '''oox::xls::ExcelFilter'''. It implements [http://api.openoffice.org/docs/common/ref/com/sun/star/document/XImporter.html XImporter] and [http://api.openoffice.org/docs/common/ref/com/sun/star/document/XFilter.html XFilter] interfaces.

== drawingml ==

drawingml containg the [[DrawingML]] parsing code.

== ppt ==

ppt contain the [[PresentationML]] parsing code.

== token ==

The token list is generated by parsing the XML Schemas. Then gentoken.pl will use gperf to generate a perfect hash for fast parsing of known tokens. All the token are dispatched through integer numbers.

== xls ==
This directory includes code specific to parse [[SpreadsheetML]].

[[Category:Office Open XML]]
[[Category:Source_directories]]
[[Category:Filter]]

Office Open XML/Legacy Implementation

2007-10-26T16:42:42Z

Hub: /* OO.o Implementation */

= OOXML Basics =

"Office Open XML" is an XML based file format that has been published as [http://www.ecma-international.org/publications/standards/Ecma-376.htm ECMA-376]. It is used as default file format by Microsoft Office 2007.

There are plans to support this file format in OpenOffice.org for interoperation with Microsoft Office 2007.

There are 3 major types of formats

* [[WordprocessingML]] - For word processor documents (file extensions may be docx, docm)
* [[SpreadsheetML]] - For spreadsheet documents (file extensions may be xlsx, xlsm)
* [[PresentationML]] - For presentation documents (file extensions may be pptx, pptm)
* [[DrawingML]] - Used by other markup language to represent graphics data.
* [[VML]] - A legacy vector markup.

== Packaging Conventions ==
OpenXML document is a package that consists of a flat collection of '''"parts"'''. Each "part" has a case-''insensitive'' part name that consists of a slash (/) delimited sequence of segment names such as "/pres/slides/slide1.xml".

For the most part, the ZIP compression is used to package the parts, in which case the term '''"package"''' refers to the ZIP archive, and the parts refer to the individual files archived within. The part name in this case is the file path within the archive.

Each part also has a '''content type''', and '''/[Content_Types].xml''' provides the content type of each part within the archive.

== Relationships ==
Packages and parts can contains '''explicit relationships''' to other parts as well as to external resources. Every explicit relationship has an ID and a type, and relationship types are named using URIs.

The set of explicit relationships for each package or part is stored in a relationship part whose name (or path) follows a specific convention e.g. the relationship part for a part called '''"/a/b/c.xml"''' is called '''"/a/b/_rels/c.xml.rels"'''. As a special case, the relationship part for the package as a whole is called '''"/_rels/.rels"'''.

= OO.o Implementation =
There is some code in the oox module ([[OOX]]) from the [[Xml]] project. The [[CWS]] is xmlfilter02 in SRC680. ([http://eis.services.openoffice.org/EIS2/cws.ShowCWS?Path=SRC680%2Fxmlfilter02 view the workspace on EIS])

To fetch the oox code from CVS (using CVS_ROOT is set properly):

cvs co -r cws_src680_xmlfilter02 -d oox xml/oox

One important note: we use the term '''fragment''' in the name of our source files to correspond with what the standard calls '''part'''. For instance, the source file that contains class definition that handles the workbook part in [[SpreadsheetML]] is called workbookfragment.cxx. This convention is prevalent across all application types within [[oox]] module.

Bonsai is also convenient to follow the changes:

[http://www.go-oo.org/bonsai/cvsquery.cgi?treeid=default&module=all&branch=cws_src680_xmlfilter02&branchtype=match&dir=xml%2Foox&file=&filetype=match&who=&whotype=match&sortby=Date&hours=2&date=week&mindate=&maxdate=&cvsroot=%2Fvar%2Fcvsup the changes done in the last 2 weeks]

Word document import is in the [[WriterFilter|writerfilter]] module.

== Implementation Generalities ==

The whole [[OOX]] filter makes use of the new [[FastParser]] service to implement an event driven [[SAX]] parser.

== Various Resources ==

* http://blogs.sun.com/GullFOSS/entry/office_open_xml_import_filter
* [http://eis.services.openoffice.org/EIS2/cws.ShowCWS?Path=SRC680%2Fxmlfilter02 CWS on EIS]
* [http://www.ecma-international.org/publications/standards/Ecma-376.htm ECMA published standard]
* [http://www.ecma-international.org/news/TC45_current_work/TC45_available_docs.htm Ecma Office Open XML File Formats Standard]
* [http://blogs.msdn.com/brian_jones/archive/2005/06/20/430892.aspx Brian Jones introduction to the Office 12 File Format]

[[Category:Filter]]
[[Category:Office Open XML]]

WriterFilter

2007-10-26T16:42:12Z

Hub: /* Prerequisites */ typo

== Download Install Sets for Current Milestone ==

We provide downloads for the current milestone (Solaris SPARC, Linux and Windows) here:

http://ooo.services.openoffice.org/pub/OpenOffice.org/cws/upload/writerfilter2/

== Getting Current Source Code for WriterFilter ==

WriterFilter is currently not included in the build system. You have to check it out manually:
<pre>
cvs -d:pserver:anoncvs@anoncvs.services.openoffice.org:/cvs co sw/writerfilter
</pre>

== Installing WriterFilter ==

=== Prerequisites ===

The current [[CWS]] for WriterFilter is <code>xmlfilter02</code>. It previously was in <code>writerfilter2</code>. Have a look in [[EIS]] for details on the CWS.

You will need an installed StarOffice/OOo and the following projects:
* comphelper
* filter
* jurt
* offapi
* offuh
* scp2
* svtools
* svx
* sw

Compile these projects and deliver the libraries to your installation in <code><SOINST></code>.

=== Changing Filter Detection ===

In
<code><SOINST>/share/registry/modules/org/openoffice/TypeDetection/Filter/fcfg_writer_filters.xcu</code>
add node with attribute <code>oor:name="MS Word 97"</code>:
<pre>
<node oor:name="MS Word 97" oor:op="replace">
<prop oor:name="Flags"><value>IMPORT EXPORT ALIEN 3RDPARTYFILTER</value></prop>
<prop oor:name="UIComponent"/>
<prop oor:name="FilterService"><value>com.sun.star.comp.Writer.WriterFilter</value></prop>
<prop oor:name="UserData"><value>CWW8</value></prop>
<prop oor:name="UIName">
<value xml:lang="x-default">Microsoft Word 97/2000/XP (new)</value>
</prop>
<prop oor:name="FileFormatVersion"><value>0</value></prop>
<prop oor:name="Type"><value>writer_MS_Word_97</value></prop>
<prop oor:name="TemplateName"/>
<prop oor:name="DocumentService"><value>com.sun.star.text.TextDocument</value></prop>
</node>
</pre>
Remember to grant yourself write access to the xcu.

=== Create Resource Database for New Intefaces ===

Note: This is only necessary if you do not use CWS xmlfilter02.

Generate resource database for new interfaces: In <code>offapi/<platform>/ucr/com/sun/star/text</code> call
<pre>regmerge /tmp/merge.rdb -UCR XTextAppend.urd</pre>

=== Register New Interfaces ===

Note: Again, only necessary if not using the CWS xmlfilter02

In <code><SOINST>/program</code> call
<pre>
./unopkg add /tmp/merge.rdb
</pre>

=== Register filter component ===

In <code><SOINST>/program</code> call
<pre>
chmod u+w services.rdb
regcomp -register -r services.rdb -c <writerfilter lib>
</pre>

Now, if you load a file recognized as "Word 97", WriterFilter will be used.

== Documentation ==

* Documentation generated by Doxygen (will be available soon)

== Debug tokenizers ==

You will need an installation of OpenOffice.org with the libraries from writerfilter delivered into the $SOINST/program directory.

=== Dump WW8 tokens ===

<pre>
$SOINST/program/uno -l libwriterfilter.uno.so -c debugservices.doctok.ScannerTestService -- file://...
</pre>

=== Dump OOXML tokens ===

<pre>
$SOINST/program/uno -l libwriterfilter.uno.so -c debugservices.ooxml.ScannerTestService -- file://...
</pre>

== Notes ==

The properties of sprm 0x6a03 (sprmCPicLocation) have to be resolved. Otherwise the FC of the picture to come is not stored.

[[Category:Filter]]
[[Category:Office Open XML]]

WriterFilter

2007-10-26T16:41:26Z

Hub: xmlfilter02 move + category

== Download Install Sets for Current Milestone ==

We provide downloads for the current milestone (Solaris SPARC, Linux and Windows) here:

http://ooo.services.openoffice.org/pub/OpenOffice.org/cws/upload/writerfilter2/

== Getting Current Source Code for WriterFilter ==

WriterFilter is currently not included in the build system. You have to check it out manually:
<pre>
cvs -d:pserver:anoncvs@anoncvs.services.openoffice.org:/cvs co sw/writerfilter
</pre>

== Installing WriterFilter ==

=== Prerequisites ===

The current [[CWS]] for WriterFilter is <code>xmlfilter02</code>. It previously was in <code>wrinterfilter2</code>. Have a look in [[EIS]] for details on the CWS.

You will need an installed StarOffice/OOo and the following projects:
* comphelper
* filter
* jurt
* offapi
* offuh
* scp2
* svtools
* svx
* sw

Compile these projects and deliver the libraries to your installation in <code><SOINST></code>.

=== Changing Filter Detection ===

In
<code><SOINST>/share/registry/modules/org/openoffice/TypeDetection/Filter/fcfg_writer_filters.xcu</code>
add node with attribute <code>oor:name="MS Word 97"</code>:
<pre>
<node oor:name="MS Word 97" oor:op="replace">
<prop oor:name="Flags"><value>IMPORT EXPORT ALIEN 3RDPARTYFILTER</value></prop>
<prop oor:name="UIComponent"/>
<prop oor:name="FilterService"><value>com.sun.star.comp.Writer.WriterFilter</value></prop>
<prop oor:name="UserData"><value>CWW8</value></prop>
<prop oor:name="UIName">
<value xml:lang="x-default">Microsoft Word 97/2000/XP (new)</value>
</prop>
<prop oor:name="FileFormatVersion"><value>0</value></prop>
<prop oor:name="Type"><value>writer_MS_Word_97</value></prop>
<prop oor:name="TemplateName"/>
<prop oor:name="DocumentService"><value>com.sun.star.text.TextDocument</value></prop>
</node>
</pre>
Remember to grant yourself write access to the xcu.

=== Create Resource Database for New Intefaces ===

Note: This is only necessary if you do not use CWS xmlfilter02.

Generate resource database for new interfaces: In <code>offapi/<platform>/ucr/com/sun/star/text</code> call
<pre>regmerge /tmp/merge.rdb -UCR XTextAppend.urd</pre>

=== Register New Interfaces ===

Note: Again, only necessary if not using the CWS xmlfilter02

In <code><SOINST>/program</code> call
<pre>
./unopkg add /tmp/merge.rdb
</pre>

=== Register filter component ===

In <code><SOINST>/program</code> call
<pre>
chmod u+w services.rdb
regcomp -register -r services.rdb -c <writerfilter lib>
</pre>

Now, if you load a file recognized as "Word 97", WriterFilter will be used.

== Documentation ==

* Documentation generated by Doxygen (will be available soon)

== Debug tokenizers ==

You will need an installation of OpenOffice.org with the libraries from writerfilter delivered into the $SOINST/program directory.

=== Dump WW8 tokens ===

<pre>
$SOINST/program/uno -l libwriterfilter.uno.so -c debugservices.doctok.ScannerTestService -- file://...
</pre>

=== Dump OOXML tokens ===

<pre>
$SOINST/program/uno -l libwriterfilter.uno.so -c debugservices.ooxml.ScannerTestService -- file://...
</pre>

== Notes ==

The properties of sprm 0x6a03 (sprmCPicLocation) have to be resolved. Otherwise the FC of the picture to come is not stored.

[[Category:Filter]]
[[Category:Office Open XML]]

PowerPoint filter

2007-10-26T16:32:23Z

Hub:

= PowerPoint filter =

The PowerPoint filter is in charge of import and export of PowerPoint binary document (.PPT) into [[Impress]]. If you are a looking for the PPTX files from PowerPoint 2007, please go to the [[Office Open XML]].

The [[PowerPoint filter]] is maintained by [[User:Sj|Sven Jacobi]].

== Import ==

The import code is scattered between the svx and sd modules.
Relevant files are in:
* sd/source/filter/ppt
* svx/source/svdraw/svdfppt.cxx

== Export ==

The export code is contained in sd/source/filter/eppt

[[Category:Impress]]

Impress

2007-10-26T16:27:03Z

Hub:

'''OpenOffice.org Impress''' is the presentation application of [[OpenOffice.org]].

The application's source code is located in module sd. The mailing list for developer discussions related to Impress is dev@graphics.openoffice.org, to subscribe mailto:dev-subscribe@graphics.openoffice.org and then reply to the subscription mail sent to you to verify subscription. The project's webpage is http://graphics.openoffice.org/

For wiki articles related to the project see [[:Category:Impress]].

== People ==

* working permanently on the code
*; [[User:Ka|Kai Ahrens]] : project lead, all areas
*; [[User:Cl|Christian Lippka]] : co-lead, view, core, API, ODF
*; [[User:Af|Andre Fischer]] : view, Accessibility, [[Presenter Screen]], [[drawing framework]]
*; [[User:Sj|Sven Jacobi]] : [[PowerPoint filter|Microsoft Powerpoint import/export filters]], [[graphic filters]], [[custom shapes]], extensions
*; [[User:Aw|Armin Le Grand]] : [[drawing engine]], [[basegfx]]
*; [[User:Thb|Thorsten Behrens]] : [[presentation module]], [[basegfx]]

* QA
*; [[User:Wg|Wolfram Garten]] : all areas
*; [[User:Cgu|Christian Guenther]] : all areas
*; [[User:Fha|Fredrik Haegg]] : testtool automation

== Work in Progress ==

* Adding native tables to impress & draw
* Adding the [[Presenter Screen]] for Impress.
* Adding [[DrawingPrimitive|primitive]] support for drawing layer (supporting smother geometry and anti aliasing)
* [[Oox|Office 12 XML import filter]]

== Draft Specifications ==

The following is a list of specifications for draw or impress that is currently working on. Please feel free to discuss
this specifications on the dev@graphics.openoffice.org mailing list.

* [[Draw_Tables|Tables in impress]]
* [[Impress_Terminology|Working on terminology in impress]]

[[Category:Impress|Impress]]
[[Category:Development]]
[[Category:Quality Assurance]]
[[Category:Project]]

DrawingML

2007-10-26T15:38:10Z

Hub: /* SmartArt */

[[DrawingML]] is the ML for graphics data in [[Office Open XML]].

It is used throughout the whole Office suite for graphics data like in [[PresentationML]] and [[WordprocessingML]]

== Data model ==

=== Shapes ===

oox::drawingml::Shape is the main data structure for the [[DrawingML]]. It will contain many XShape all created from the drawingml.

The class Shape, every hard shape attribute is stored there. The text will be stored in the shape.

=== Text ===

The class "TextListStyle" is storing style information
"TextParagraphProperties" for
each of the ten text paragraphs (also a aggregation list style that is
used for sub titles)

The "TextParagraphProperties" class is storing paragraph and character
properties.

=== SmartArt ===

[[SmartArt]] is the "diagramming" part of DrawingML. OpenOffice.org do not have an equivalent feature so the import will have to include the logic of SmartArt to generate Shapes from the whole diagram description.

Diagrams are in their own fragments and in it their own XML namespace.

[[Category:Office Open XML]]
[[Category:Impress]]

SmartArt

2007-10-26T15:37:34Z

Hub: /* SmartArt */

= SmartArt =

SmartArt is one of the new features of MS-Office 2007 and is about simply creating diagrams automatically. You select a layout, select colors, enter some textual data, and voilà.

This is the diagram part of [[DrawingML]]

== Import ==

The current strategy to import is to generate shapes from the diagram data. The result will be lossy compared to the [[Office Open XML]] document as it will not include the diagram information anymore. Don't expect round-trip conversion.

== Generation ==

The generation of a SmartArt is the action of generating drawing elements from the data model, layout and color style combination.

== Future? ==

This is just ideas for the future. These are not actual plans.

Ideally in the future, OpenOffice.org could have a similar feature with a UI. That would require changes in both the file format and the importer. It could be written as an extension, and should be available to all the OpenOffice.org components: Writer, Calc, Draw and Impress.

[[Category:Office Open XML]]
[[Category:Impress]]

SmartArt

2007-10-26T15:37:12Z

Hub: /* Import */

= SmartArt =

SmartArt is one of the new features of MS-Office 2007 and is about simply creating diagrams automatically. You select a layout, select colors, enter some textual data, and voilà.

This is the diagram part of [[DrawningML]]

== Import ==

The current strategy to import is to generate shapes from the diagram data. The result will be lossy compared to the [[Office Open XML]] document as it will not include the diagram information anymore. Don't expect round-trip conversion.

== Generation ==

The generation of a SmartArt is the action of generating drawing elements from the data model, layout and color style combination.

== Future? ==

This is just ideas for the future. These are not actual plans.

Ideally in the future, OpenOffice.org could have a similar feature with a UI. That would require changes in both the file format and the importer. It could be written as an extension, and should be available to all the OpenOffice.org components: Writer, Calc, Draw and Impress.

[[Category:Office Open XML]]
[[Category:Impress]]

SmartArt

2007-10-26T15:36:37Z

Hub: initial documentation

= SmartArt =

SmartArt is one of the new features of MS-Office 2007 and is about simply creating diagrams automatically. You select a layout, select colors, enter some textual data, and voilà.

This is the diagram part of [[DrawningML]]

== Import ==

The current strategy to import is to generate shapes from the diagram data. The result will be lossy compared to the MS-Office document as it will not include the diagram information anymore. Don't expect round-trip conversion.

== Generation ==

The generation of a SmartArt is the action of generating drawing elements from the data model, layout and color style combination.

== Future? ==

This is just ideas for the future. These are not actual plans.

Ideally in the future, OpenOffice.org could have a similar feature with a UI. That would require changes in both the file format and the importer. It could be written as an extension, and should be available to all the OpenOffice.org components: Writer, Calc, Draw and Impress.

[[Category:Office Open XML]]
[[Category:Impress]]

DrawingML

2007-10-26T15:30:29Z

Hub:

Oox

2007-10-26T15:28:19Z

Hub: /* drawingml */

UNO

2007-09-13T17:34:30Z

Hub: alias

#REDIRECT [[Uno]]

Source code directories

2007-09-06T22:18:26Z

Hub:

Below is a (somewhat terse) description of the various directories for OpenOffice source code.

{| border="1"
| [[agg]] || antigrain geometry lib (from http://www.antigrain.com/), a software renderer used in canvas
|-
| [[animation]] || Containers for the css::animation UNO API, used in slideshow and sd
|-
| [[autodoc]] || html pages from c++, java, idl inline documentation
|-
| [[automation]] || Hook for QA automation (TestTool)
|-
| [[avmedia]] || Audio/Video media implementation - requires a working Java Media Framework (JMF)
* currently can't play streams only file-system URIs anyway.
|-
| [[basctl]] || controls and dialogs - basic
|-
| [[basebmp]] || algorithms and data types for bitmap graphics (e.g. line and fill polygon scan conversion, bitmap format iterators, and a SalGraphics-compatible software renderer)
|-
| [[basegfx]] || algorithms and data types for graphics (e.g. polygons, vectors, matrices and the like - see that used in canvas)
|-
| [[basic]] || basic interpreter
|-
| [[OOoBean|bean]] || office bean
|-
| [[beanshell]] || java interpreter - so you can write java in command shell,
* interactive java -- good for prototyping /macros
* from http://www.beanshell.org/ with some patches
|-
| [[berkeleydb]] || external library. http://www.sleepycat.com/products/db.shtml simple db - used for search in help and galleries
|-
| [[Framework/Modules/binfilter|binfilter]] || [[StarOffice]] 5.2 compatibility layer, the UI and everything. Basically a little SO 5.2 inside OO.o. This is huge - avoid building it by giving '--disable-binfilter' on the configure line.
|-
| [[boost]] || external (C++ template) library: http://boost.org/native
|-
| [[Uno/Binary/Module/bridges|bridges]] || Bridges from various C++ ABIs, Java JNI, MS .Net to [[Uno/Binary|Binary Uno]]. Also implementation of the [[Uno]] Remote Protocol. And in ooo-build a bridge from Mono to [[Uno]] and back.
|-
| [[canvas]] || new canvas implementation to improve rendering, various backends implement the new XCanvas API eg. cairo / DirectX
|-
| [[chart2]] || new, improved chart implementation, arrived in OO.o 2.3
|-
| [[Uno/CLI/Modules/cli_ure|cli_ure]] || '''C'''ommon '''L'''anguage '''I'''nfrastructure '''U'''no '''R'''untime '''E'''nvironment -- support assemblies and tools for the MS .Net (and Mono) [[Uno]] binding.
|-
| [[Uno/Binary/Module/codemaker|codemaker]] || [[Uno]] interface declaration/stub generators for [[Uno/Cpp|C++ Uno]] (headers), [[Uno/Java|Java Uno]] (class files), [[Uno/CLI|CLI (.Net / Mono) Uno]].
|-
| <div id="configmgr">[[configmgr]]</div> || the configuration database - UNO services and some tools
|-
| [[config_office]] || build configs, configure scripts, autotools, etc.
|-
| [[connectivity]] || database pieces, drivers, etc.
|-
| [[cosv]] || "Common Services," part of [[autodoc]]
|-
| [[cppcanvas]] || helper C++ classes for canvas, plus a GDIMetaFile-to-XCanvas converter
|-
| [[Uno/Binary/Modules/CPPU|cppu]] || [[Uno/Binary|Binary (read 'C') Uno]] runtime.
|-
| [[Uno/Cpp/Module/CPPUhelper|cppuhelper]] || [[Uno/Cpp|C++ Uno]] runtime, additionally helpers e.g. templates for implementing Uno components, bootstrapping stuff etc. - get Uno up & running.
|-
| [[Uno/Binary/Module/CPPUtools|cpputools]] || [[Uno/Binary|Binary Uno]] tools, like uno.exe, regcomp etc.
|-
| [[crashrep]] || reports crashes (Novell disabled that)
|-
| [[curl]] || external library [http://curl.haxx.se curl] (a URL manipulation engine)
|-
| [[dbaccess]] || data base access tools
|-
| [[default_images]] || all images and resources
|-
| [[desktop]] || what used to be the desktop in SO5 - now the binary
|-
| [[dmake]] || the dmake tool itself, built by running 'bootstrap' after configure
|-
| [[dtrans]] || clipboard abstraction - data transfer
|-
| [[embeddedobj]] || Embedding objects
|-
| [[embedserv]] || Embed OOo through OLE2
|-
| [[epm]] || enhanced package manager- nasty hack for packaging
* not useful - but default build uses, every linux packager disables this
|-
| [[eventattacher]] || how basic handles events -
|-
| [[expat]] || external library with added UCS2 support, ... simple SAX parser
|-
| [[extensions_(source_code_module)|extensions]] || browser plugin, activex control, scanner bits
|-
| [[external]] || placeholder for extra code needed to build
|-
| [[extras]] || templates, clipart galleries, palettes, symbol font etc.
|-
| [[fileaccess]] || tiny: implements XSimpleFileAccess interface - that makes the UCB interfaces actually usable (via [[Uno]]) and more intuitive.
|-
| [[filter]] || filter registration and some simple filters (also descriptions
|-
| [[forms]] || embedded forms control and pieces (design forms in documents, fields and database driven)
|-
| [[fpicker]] || native file pickers for Unix and Windows (file open dialog) GTK+, KDE, Windows
|-
| [[Framework]] || UI rewrite, toolbars, menus, [[Uno]] stuff, including accelerators & interaction, etc.
|-
| [[External/Modules/freetype|freetype]] || Font rasterrizer.
|-
| [[goodies]] || graphics filters, 3d and 2d graqphics pieces
|-
| [[helpcontent2]] || for OpenOffice.org 2 - english + other languages help content
|-
| [[hsqldb]] || external library. http://hsqldb.org/ Java database engine. Default database format for OpenOffice.org
|-
| [[hwpfilter]] || filter for a word processor file format popular in Korea. (Hangul Word Processor)
|-
| [[i18npool]] || internationalization, counting, calendaring, complex text layout
|-
| [[i18nutil]] || small bits of internationalization
|-
| [[ICU|icu]] || external library. International (IBM? ;-)) Components for Unicode, http://icu.sourceforge.net/ with patches.
|-
| [[idl]] || SvIDL Compiler
|-
| [[Uno/Binary/Module/idlc|idlc]] || The [[Uno/Specifications/IDL|Uno IDL]] compiler.
|-
| [[instsetoo_native]] || install set for oo, native installers -
|-
| [[Util/Module/IO|io]] || Provides socket and pipe acceptors / connectors, as well as text input / output streams.
|-
| [[Uno/Java/Module/javaunohelper|javaunohelper]] || [[Uno/Java|Java Uno]] components implementation helpers.
|-
| [[Uno/Java/Module/JURT|jurt]] || '''J'''ava '''U'''no '''R'''un'''t'''ime - Basically [[Uno/Java|Java Uno]].
|-
| [[Util/Module/JUT|jut]] || '''J'''ava '''U'''no '''T'''ools - Tools for [[Uno/Java|Java Uno]].
|-
| [[jvmaccess]], [[jvmfwk]] || wrappers so you can use all the Java Runtime Environments with their slightly incompatible APIs with ease. Hah.
|-
| [[libwpd]] || external library. Not modified. http://libwpd.sourceforge.net/ wordperfect filter - SAX api - emits callbacks when things happen
|-
| [[libxmlsec]] || external library. (Still) heavily patched. http://www.aleksey.com/xmlsec/ to do XML signing, etc.
|-
| [[lingucomponent]] || spellcheck, hyphenator, thesaurus, ...
|-
| [[linguistic]] || This component manages all registered linguistic module implementations for spellchecker, hyphenator and thesaurus.
|-
| [[lpsolve]] || external library that provides a mixed integer linear programming (MILP) solver, see http://lpsolve.sourceforge.net
|-
| [[mathmldtd]] || MathMLDTD to implement XML Math format, see http://www.w3.org/TR/REC-MathML
|-
| [[msfontextract]] || external library. http://www.kyz.uklinux.net/libmspack/ for use in FontOOo (unpacking the downloaded Microsoft fonts (webfont))
|-
| [[nas]] || The Network Audio System (NAS), An Audio Protocol For Networks. See http://radscan.com/nas.html
|-
| [[neon]] || web library to help deal with WebDAV or other protocols
|-
| [[netbeans_integration]] || java?
|-
| [[np_sdk]] || Netscape Plugin SDK. Header to build Mozilla plugins.
|-
| [[odk]] || office development kit - implements the first step on the way to the OpenOffice.org SDK tarball
|-
| [[offapi]] || all of the [[Uno/Specification/IDL|Uno IDL]] files except those in [[#udkapi|udkapi]] - i.e. the interfaces that are specific to the OpenOffice.org application.
|-
| [[officecfg]] || the schema and default settings for the [[#configmgr|OpenOffice.org configuration database]]
|-
| [[offuh]] || Tiny module to build the generate the [[Uno/Cpp|C++ Uno]] headers.
|-
| [[oocustomimages]] || themes, custom themes
|-
| [[OOX|oox]] || [[OpenXML]] parser
|-
| [[packages]] || reading and writing zips
|-
| [[padmin]] || printer administration dialog - used lpr - obsolete with CUPS and fontconfig, but still used for some things
|-
| [[External/Modules/portaudio|portaudio]] || an audio output library for various sound setups.
|-
| [[postprocess]] || Postprocessing and checking of files delivered by other modules. This module has to be the last one before creating install sets in module 'instset_native'.
|-
| [[psprint]] || postscript print - unix only - implements font discovery, interface to CUPS / lpr, query and basic PS - dump PS on print - actual PS rendering inside vcl
|-
| [[psprint_config]] || ppds for use by psprint when not using CUPS
|-
| [[pyuno]] || [[Uno]] binding for python
|-
| [[qadevOOo]] || qa testsuite
|-
| [[Uno/Binary/Module/rdbmaker|rdbmaker]] || makes registries for openoffice for storing type data, etc./?
|-
| [[readlicense_oo]] || reading oo license when starting up
|-
| [[regexp]] || regular expression matching
|-
| [[registry]] || registry reading, etc.
|-
| [[Uno/Binary/Module/remotebridges|remotebridges]] || [[Uno]] services dealing with interprocess bridges.
|-
| [[rhino]] || java script engine/interpreter
|-
| [[Uno/Java/Module/ridljar|ridljar]] || Generators [[Uno/Java|Java Uno]] types (like [[offuh]]).
|-
| [[rsc]] || resource compiler - turns resource descriptions src and hrc files scattered throughout.
|-
| [[rvpapi]] || Obsolete.
|-
| [[sablot]] || external library. yet another xslt implementation in the tree (in C++)
|-
| [[Porting/Module/SAL|sal]] || system abstraction layer - rtl, osl and sal (rtl - platform independent strings, osl - platform specific stuff, threads, dynamic loading, process, ipc, etc.). Exports only C API and some inline-methods-only C++ API
|-
| [[Uno/Cpp/Module/SALhelper|salhelper]] || C++ helpers to make use of sal easier
|-
| [[Util/Module/sandbox|sandbox]] || Generic sandboxing, e.g. used for Java applet embedding stuff. Totally useless without a Sun JDK. Might be obsolet.
|-
| [[sane]] || external scanner library
|-
| [[sax]] || wrapper around expat using [[Uno]].
|-
| [[sc]] || calc - the Spreadsheet core
|-
| [[scaddins]] || extra functions for calc
|-
| [[scp2]] || script particles - being rewritten for oo2. all of installation was driven by starbasic - this is now in instsetoo-native
|-
| [[scripting]] || scripting framework - for java, python, etc. to play together and uses UNO
|-
| [[scsolver]] || [[Optimization Solver]] for Calc
|-
| [[sd]] || Impress and Draw components. Think of Impress as hack on top of Draw.
|-
| [[sdext]] || Extensions for the Impress and Draw applications.
|-
| [[sdk_oo]] || software development kit OO - implements the second step on the way to the OpenOffice.org SDK tarball (see odk)
|-
| [[setup-native]] || ?
|-
| [[sfx2]] || gui code, much of which is now deprecated - list of documents open would be tracked - raw C++ code; gutsy core of document management and loading.
|-
| [[shell]] || system helpers - launching URI, recently used files, system integration, external mailer support, gconf integration etc.
|-
| [[sj2]] || Java Applet support.
|-
| [[slideshow]] || new impress slideshow engine in OO.o 2.0
|-
| [[smoketestoo_native]] || Test code to launch each component for a smoke test.
|-
| [[sndfile]] || soundfile - library for loading all kinds of sound - external lib
|-
| [[so3]] || StarObject (v3)
|-
| [[solenv]] || make and build infrastructure - solar (think: Sun or Star Division) environment
|-
| [[soltools]] || all sorts of build tools
|-
| [[solver]] || dumping ground for binaries as object output
|-
| [[sot]] || compound file storage tools code (?)
|-
| [[starmath]] || formula editor
|-
| [[External/Modules/stlport|stlport]] || external library. STL implementation, from the days when compilers had crappy implementations.
|-
| [[Uno/Binary/Module/STOC|stoc]] || Core Components for [[Uno/Binary|Binary Uno]] (e.g. registry access, reflection, introspection).
|-
| [[store]] || Storage implementations, used by [[Uno]] registries.
|-
| [[svtools]] || useful code, common dialogs, file and print dialogs, wizards, vcl filters, lots of helper code
|-
| [[svx]] || Graphics related helper code - xoutdev - rendering - This is where a lot of work would happen to move to the canvas. svdraw - transparent gradient stuff. Lot of the Draw and Impress code is in this module. Part if the PPT binary importer is in there too.
|-
| [[sw]] || writer - the word processing core
|-
| [[sysui]] || .desktop files for different distros
|-
| [[toolkit]] || abstract windowing thing- [[Uno]] implementations of windows stuff - so can be used from basic
|-
| [[tools]] || predates sal - string etc. functions, url manip, stream stuff, polygons, etc.
|-
| [[transex3]] || translation tools
|-
| [[twain]] || Windows scanner support
|-
| [[ucb]] || '''U'''niversal '''C'''ontent '''B'''roker (has ucp) which do things like convert files to strings in content broker world.
|-
| [[ucbhelper]] || C++ wrappers to help make using content providers easy
|-
| <div id="udkapi">[[udkapi]]</div> || URE API definition - [[Uno/Specification/IDL|Uno IDL]] files
|-
| [[udm]] || part of [[autodoc]]
|-
| [[unixODBC]] || external lib
|-
| [[unocontrols]] || separate process and thread for progress bars, etc.
|-
| [[unoil]] || Like offuh for [[Uno/Java|Java Uno]] - Generates Java class files from OOo application Uno types.
|-
| [[unotools]] || helpers for C++ use of UNO
|-
| [[unoxml]] || [[Uno]] wrappers for XML services
|-
| [[unzip]] || used by installer
|-
| [[ure]] || beginnings of standalone UNO distribution foo.
|-
| [[uui]] || An Interaction Handler for the UCB. It uses VCL to visualize and handle interaction requests.
|-
| [[vcl]] || base windowing toolkit abstraction Visual Class Libraries, and graphical output layer - includes backends for unix & Win32
|-
| [[vigra]] || Template framework from [http://kogs-www.informatik.uni-hamburg.de/~koethe/vigra/ here]. VIGRA stands for "Vision with Generic Algorithms". Used from [[basebmp]].
|-
| [[vos]] || (Virtual Object System) - deprecated but still used, lots of sal like stuff
|-
| [[wizards]] || java wizards for db setup, importing, tutorials, etc.
|-
| [[writerperfect]] || word perfect filter - wrapper for libwpd
|-
| [[X11_extensions]] || headers for XRender support
|-
| [[xalan]] || external library. java xslt implementation
|-
| [[xmerge]] || The XMerge SDK provides a Java-based framework for converting documents between different formats using conversion plugins to read and write each format. See http://xml.openoffice.org/xmerge
|-
| [[xml2cmp]] || Comes with the OO SDK. xml2cmp is launched in general by a makefile to extract types from a xml file
|-
| [[xmlhelp]] || Help reader and viewer for online help
|-
| [[xmloff]] || OpenDocument import / export filter.
|-
| [[xmlscript]] || Implements XML dialogs serialization.
|-
| [[xmlSearch]] || ?
|-
| [[xmlSecurity]] || Document signing
|-
|}

[[Category:Source directories]]

Source code directories

2007-08-27T20:24:56Z

Hub: more

Below is a (somewhat terse) description of the various directories for OpenOffice source code.

{| border="1"
| [[agg]] || antigrain geometry lib (from http://www.antigrain.com/), a software renderer used in canvas
|-
| [[animation]] || Containers for the css::animation UNO API, used in slideshow and sd
|-
| [[autodoc]] || html pages from c++, java, idl inline documentation
|-
| [[automation]] || Hook for QA automation (TestTool)
|-
| [[avmedia]] || Audio/Video media implementation - requires a working Java Media Framework (JMF)
* currently can't play streams only file-system URIs anyway.
|-
| [[basctl]] || controls and dialogs - basic
|-
| [[basebmp]] || algorithms and data types for bitmap graphics (e.g. line and fill polygon scan conversion, bitmap format iterators, and a SalGraphics-compatible software renderer)
|-
| [[basegfx]] || algorithms and data types for graphics (e.g. polygons, vectors, matrices and the like - see that used in canvas)
|-
| [[basic]] || basic interpreter
|-
| [[OOoBean|bean]] || office bean
|-
| [[beanshell]] || java interpreter - so you can write java in command shell,
* interactive java -- good for prototyping /macros
* from http://www.beanshell.org/ with some patches
|-
| [[berkeleydb]] || external library. http://www.sleepycat.com/products/db.shtml simple db - used for search in help and galleries
|-
| [[Framework/Modules/binfilter|binfilter]] || [[StarOffice]] 5.2 compatibility layer, the UI and everything. Basically a little SO 5.2 inside OO.o. This is huge - avoid building it by giving '--disable-binfilter' on the configure line.
|-
| [[boost]] || external (C++ template) library: http://boost.org/native
|-
| [[Uno/Binary/Module/bridges|bridges]] || Bridges from various C++ ABIs, Java JNI, MS .Net to [[Uno/Binary|Binary Uno]]. Also implementation of the [[Uno]] Remote Protocol. And in ooo-build a bridge from Mono to [[Uno]] and back.
|-
| [[canvas]] || new canvas implementation to improve rendering, various backends implement the new XCanvas API eg. cairo / DirectX
|-
| [[chart2]] || new, improved chart implementation, arrived in OO.o 2.3
|-
| [[Uno/CLI/Modules/cli_ure|cli_ure]] || '''C'''ommon '''L'''anguage '''I'''nfrastructure '''U'''no '''R'''untime '''E'''nvironment -- support assemblies and tools for the MS .Net (and Mono) [[Uno]] binding.
|-
| [[Uno/Binary/Module/codemaker|codemaker]] || [[Uno]] interface declaration/stub generators for [[Uno/Cpp|C++ Uno]] (headers), [[Uno/Java|Java Uno]] (class files), [[Uno/CLI|CLI (.Net / Mono) Uno]].
|-
| <div id="configmgr">[[configmgr]]</div> || the configuration database - UNO services and some tools
|-
| [[config_office]] || build configs, configure scripts, autotools, etc.
|-
| [[connectivity]] || database pieces, drivers, etc.
|-
| [[cosv]] || "Common Services," part of [[autodoc]]
|-
| [[cppcanvas]] || helper C++ classes for canvas, plus a GDIMetaFile-to-XCanvas converter
|-
| [[Uno/Binary/Module/CPPU|cppu]] || [[Uno/Binary|Binary (read 'C') Uno]] runtime.
|-
| [[Uno/Cpp/Module/CPPUhelper|cppuhelper]] || [[Uno/Cpp|C++ Uno]] runtime, additionally helpers e.g. templates for implementing Uno components, bootstrapping stuff etc. - get Uno up & running.
|-
| [[Uno/Binary/Module/CPPUtools|cpputools]] || [[Uno/Binary|Binary Uno]] tools, like uno.exe, regcomp etc.
|-
| [[crashrep]] || reports crashes (Novell disabled that)
|-
| [[curl]] || external library [http://curl.haxx.se curl] (a URL manipulation engine)
|-
| [[dbaccess]] || data base access tools
|-
| [[default_images]] || all images and resources
|-
| [[desktop]] || what used to be the desktop in SO5 - now the binary
|-
| [[dmake]] || the dmake tool itself, built by running 'bootstrap' after configure
|-
| [[dtrans]] || clipboard abstraction - data transfer
|-
| [[embeddedobj]] || Embedding objects
|-
| [[embedserv]] || Embed OOo through OLE2
|-
| [[epm]] || enhanced package manager- nasty hack for packaging
* not useful - but default build uses, every linux packager disables this
|-
| [[eventattacher]] || how basic handles events -
|-
| [[expat]] || external library with added UCS2 support, ... simple SAX parser
|-
| [[extensions_(source_code_module)|extensions]] || browser plugin, activex control, scanner bits
|-
| [[external]] || placeholder for extra code needed to build
|-
| [[extras]] || templates, clipart galleries, palettes, symbol font etc.
|-
| [[fileaccess]] || tiny: implements XSimpleFileAccess interface - that makes the UCB interfaces actually usable (via [[Uno]]) and more intuitive.
|-
| [[filter]] || filter registration and some simple filters (also descriptions
|-
| [[forms]] || embedded forms control and pieces (design forms in documents, fields and database driven)
|-
| [[fpicker]] || native file pickers for Unix and Windows (file open dialog) GTK+, KDE, Windows
|-
| [[Framework]] || UI rewrite, toolbars, menus, [[Uno]] stuff, including accelerators & interaction, etc.
|-
| [[External/Modules/freetype|freetype]] || Font rasterrizer.
|-
| [[goodies]] || graphics filters, 3d and 2d graqphics pieces
|-
| [[helpcontent2]] || for OpenOffice.org 2 - english + other languages help content
|-
| [[hsqldb]] || external library. http://hsqldb.org/ Java database engine. Default database format for OpenOffice.org
|-
| [[hwpfilter]] || filter for a word processor file format popular in Korea. (Hangul Word Processor)
|-
| [[i18npool]] || internationalization, counting, calendaring, complex text layout
|-
| [[i18nutil]] || small bits of internationalization
|-
| [[ICU|icu]] || external library. International (IBM? ;-)) Components for Unicode, http://icu.sourceforge.net/ with patches.
|-
| [[idl]] || SvIDL Compiler
|-
| [[Uno/Binary/Module/idlc|idlc]] || The [[Uno/Specifications/IDL|Uno IDL]] compiler.
|-
| [[instsetoo_native]] || install set for oo, native installers -
|-
| [[Util/Module/IO|io]] || Provides socket and pipe acceptors / connectors, as well as text input / output streams.
|-
| [[Uno/Java/Module/javaunohelper|javaunohelper]] || [[Uno/Java|Java Uno]] components implementation helpers.
|-
| [[Uno/Java/Module/JURT|jurt]] || '''J'''ava '''U'''no '''R'''un'''t'''ime - Basically [[Uno/Java|Java Uno]].
|-
| [[Util/Module/JUT|jut]] || '''J'''ava '''U'''no '''T'''ools - Tools for [[Uno/Java|Java Uno]].
|-
| [[jvmaccess]], [[jvmfwk]] || wrappers so you can use all the Java Runtime Environments with their slightly incompatible APIs with ease. Hah.
|-
| [[libwpd]] || external library. Not modified. http://libwpd.sourceforge.net/ wordperfect filter - SAX api - emits callbacks when things happen
|-
| [[libxmlsec]] || external library. (Still) heavily patched. http://www.aleksey.com/xmlsec/ to do XML signing, etc.
|-
| [[lingucomponent]] || spellcheck, hyphenator, thesaurus, ...
|-
| [[linguistic]] || This component manages all registered linguistic module implementations for spellchecker, hyphenator and thesaurus.
|-
| [[lpsolve]] || external library that provides a mixed integer linear programming (MILP) solver, see http://lpsolve.sourceforge.net
|-
| [[mathmldtd]] || MathMLDTD to implement XML Math format, see http://www.w3.org/TR/REC-MathML
|-
| [[msfontextract]] || external library. http://www.kyz.uklinux.net/libmspack/ for use in FontOOo (unpacking the downloaded Microsoft fonts (webfont))
|-
| [[nas]] || The Network Audio System (NAS), An Audio Protocol For Networks. See http://radscan.com/nas.html
|-
| [[neon]] || web library to help deal with WebDAV or other protocols
|-
| [[netbeans_integration]] || java?
|-
| [[np_sdk]] || Netscape Plugin SDK. Header to build Mozilla plugins.
|-
| [[odk]] || office development kit - implements the first step on the way to the OpenOffice.org SDK tarball
|-
| [[offapi]] || all of the [[Uno/Specification/IDL|Uno IDL]] files except those in [[#udkapi|udkapi]] - i.e. the interfaces that are specific to the OpenOffice.org application.
|-
| [[officecfg]] || the schema and default settings for the [[#configmgr|OpenOffice.org configuration database]]
|-
| [[offuh]] || Tiny module to build the generate the [[Uno/Cpp|C++ Uno]] headers.
|-
| [[oocustomimages]] || themes, custom themes
|-
| [[OOX|oox]] || [[OpenXML]] parser
|-
| [[packages]] || reading and writing zips
|-
| [[padmin]] || printer administration dialog - used lpr - obsolete with CUPS and fontconfig, but still used for some things
|-
| [[External/Modules/portaudio|portaudio]] || an audio output library for various sound setups.
|-
| [[postprocess]] || Postprocessing and checking of files delivered by other modules. This module has to be the last one before creating install sets in module 'instset_native'.
|-
| [[psprint]] || postscript print - unix only - implements font discovery, interface to CUPS / lpr, query and basic PS - dump PS on print - actual PS rendering inside vcl
|-
| [[psprint_config]] || ppds for use by psprint when not using CUPS
|-
| [[pyuno]] || [[Uno]] binding for python
|-
| [[qadevOOo]] || qa testsuite
|-
| [[Uno/Binary/Module/rdbmaker|rdbmaker]] || makes registries for openoffice for storing type data, etc./?
|-
| [[readlicense_oo]] || reading oo license when starting up
|-
| [[regexp]] || regular expression matching
|-
| [[registry]] || registry reading, etc.
|-
| [[Uno/Binary/Module/remotebridges|remotebridges]] || [[Uno]] services dealing with interprocess bridges.
|-
| [[rhino]] || java script engine/interpreter
|-
| [[Uno/Java/Module/ridljar|ridljar]] || Generators [[Uno/Java|Java Uno]] types (like [[offuh]]).
|-
| [[rsc]] || resource compiler - turns resource descriptions src and hrc files scattered throughout.
|-
| [[rvpapi]] || Obsolete.
|-
| [[sablot]] || external library. yet another xslt implementation in the tree (in C++)
|-
| [[Porting/Module/SAL|sal]] || system abstraction layer - rtl, osl and sal (rtl - platform independent strings, osl - platform specific stuff, threads, dynamic loading, process, ipc, etc.). Exports only C API and some inline-methods-only C++ API
|-
| [[Uno/Cpp/Module/SALhelper|salhelper]] || C++ helpers to make use of sal easier
|-
| [[Util/Module/sandbox|sandbox]] || Generic sandboxing, e.g. used for Java applet embedding stuff. Totally useless without a Sun JDK. Might be obsolet.
|-
| [[sane]] || external scanner library
|-
| [[sax]] || wrapper around expat using [[Uno]].
|-
| [[sc]] || calc - the Spreadsheet core
|-
| [[scaddins]] || extra functions for calc
|-
| [[scp2]] || script particles - being rewritten for oo2. all of installation was driven by starbasic - this is now in instsetoo-native
|-
| [[scripting]] || scripting framework - for java, python, etc. to play together and uses UNO
|-
| [[scsolver]] || [[Optimization Solver]] for Calc
|-
| [[sd]] || Impress and Draw components. Think of Impress as hack on top of Draw.
|-
| [[sdext]] || Extensions for the Impress and Draw applications.
|-
| [[sdk_oo]] || software development kit OO - implements the second step on the way to the OpenOffice.org SDK tarball (see odk)
|-
| [[setup-native]] || ?
|-
| [[sfx2]] || gui code, much of which is now deprecated - list of documents open would be tracked - raw C++ code; gutsy core of document management and loading.
|-
| [[shell]] || system helpers - launching URI, recently used files, system integration, external mailer support, gconf integration etc.
|-
| [[sj2]] || Java Applet support.
|-
| [[slideshow]] || new impress slideshow engine in OO.o 2.0
|-
| [[smoketestoo_native]] || Test code to launch each component for a smoke test.
|-
| [[sndfile]] || soundfile - library for loading all kinds of sound - external lib
|-
| [[so3]] || StarObject (v3)
|-
| [[solenv]] || make and build infrastructure - solar (think: Sun or Star Division) environment
|-
| [[soltools]] || all sorts of build tools
|-
| [[solver]] || dumping ground for binaries as object output
|-
| [[sot]] || compound file storage tools code (?)
|-
| [[starmath]] || formula editor
|-
| [[External/Modules/stlport|stlport]] || external library. STL implementation, from the days when compilers had crappy implementations.
|-
| [[Uno/Binary/Module/STOC|stoc]] || Core Components for [[Uno/Binary|Binary Uno]] (e.g. registry access, reflection, introspection).
|-
| [[store]] || Storage implementations, used by [[Uno]] registries.
|-
| [[svtools]] || useful code, common dialogs, file and print dialogs, wizards, vcl filters, lots of helper code
|-
| [[svx]] || graphics related helper code - xoutdev - rendering - this is where a lot of work would happen to move to the canvas. svdraw - transparent gradient stuff . lots of the draw and impress code is in this shared lib
|-
| [[sw]] || writer - the word processing core
|-
| [[sysui]] || .desktop files for different distros
|-
| [[toolkit]] || abstract windowing thing- [[Uno]] implementations of windows stuff - so can be used from basic
|-
| [[tools]] || predates sal - string etc. functions, url manip, stream stuff, polygons, etc.
|-
| [[transex3]] || translation tools
|-
| [[twain]] || Windows scanner support
|-
| [[ucb]] || '''U'''niversal '''C'''ontent '''B'''roker (has ucp) which do things like convert files to strings in content broker world.
|-
| [[ucbhelper]] || C++ wrappers to help make using content providers easy
|-
| <div id="udkapi">[[udkapi]]</div> || URE API definition - [[Uno/Specification/IDL|Uno IDL]] files
|-
| [[udm]] || part of [[autodoc]]
|-
| [[unixODBC]] || external lib
|-
| [[unocontrols]] || separate process and thread for progress bars, etc.
|-
| [[unoil]] || Like offuh for [[Uno/Java|Java Uno]] - Generates Java class files from OOo application Uno types.
|-
| [[unotools]] || helpers for C++ use of UNO
|-
| [[unoxml]] || [[Uno]] wrappers for XML services
|-
| [[unzip]] || used by installer
|-
| [[ure]] || beginnings of standalone UNO distribution foo.
|-
| [[uui]] || An Interaction Handler for the UCB. It uses VCL to visualize and handle interaction requests.
|-
| [[vcl]] || base windowing toolkit abstraction Visual Class Libraries, and graphical output layer - includes backends for unix & Win32
|-
| [[vigra]] || Template framework from [http://kogs-www.informatik.uni-hamburg.de/~koethe/vigra/ here]. VIGRA stands for "Vision with Generic Algorithms". Used from [[basebmp]].
|-
| [[vos]] || (Virtual Object System) - deprecated but still used, lots of sal like stuff
|-
| [[wizards]] || java wizards for db setup, importing, tutorials, etc.
|-
| [[writerperfect]] || word perfect filter - wrapper for libwpd
|-
| [[X11_extensions]] || headers for XRender support
|-
| [[xalan]] || external library. java xslt implementation
|-
| [[xmerge]] || The XMerge SDK provides a Java-based framework for converting documents between different formats using conversion plugins to read and write each format. See http://xml.openoffice.org/xmerge
|-
| [[xml2cmp]] || Comes with the OO SDK. xml2cmp is launched in general by a makefile to extract types from a xml file
|-
| [[xmlhelp]] || Help reader and viewer for online help
|-
| [[xmloff]] || OpenDocument import / export filter.
|-
| [[xmlscript]] || Implements XML dialogs serialization.
|-
| [[xmlSearch]] || ?
|-
| [[xmlSecurity]] || Document signing
|-
|}

[[Category:Source directories]]

Source code directories

2007-08-27T20:14:57Z

Hub: more typos

Below is a (somewhat terse) description of the various directories for OpenOffice source code.

{| border="1"
| [[agg]] || antigrain geometry lib (from http://www.antigrain.com/), a software renderer used in canvas
|-
| [[animation]] || Containers for the css::animation UNO API, used in slideshow and sd
|-
| [[autodoc]] || html pages from c++, java, idl inline documentation
|-
| [[automation]] || Hook for QA automation (TestTool)
|-
| [[avmedia]] || Audio/Video media implementation - requires a working Java Media Framework (JMF)
* currently can't play streams only file-system URIs anyway.
|-
| [[basctl]] || controls and dialogs - basic
|-
| [[basebmp]] || algorithms and data types for bitmap graphics (e.g. line and fill polygon scan conversion, bitmap format iterators, and a SalGraphics-compatible software renderer)
|-
| [[basegfx]] || algorithms and data types for graphics (e.g. polygons, vectors, matrices and the like - see that used in canvas)
|-
| [[basic]] || basic interpreter
|-
| [[OOoBean|bean]] || office bean
|-
| [[beanshell]] || java interpreter - so you can write java in command shell,
* interactive java -- good for prototyping /macros
* from http://www.beanshell.org/ with some patches
|-
| [[berkeleydb]] || external library. http://www.sleepycat.com/products/db.shtml simple db - used for search in help and galleries
|-
| [[Framework/Modules/binfilter|binfilter]] || [[StarOffice]] 5.2 compatibility layer, the UI and everything. Basically a little SO 5.2 inside OO.o. This is huge - avoid building it by giving '--disable-binfilter' on the configure line.
|-
| [[boost]] || external (C++ template) library: http://boost.org/native
|-
| [[Uno/Binary/Module/bridges|bridges]] || Bridges from various C++ ABIs, Java JNI, MS .Net to [[Uno/Binary|Binary Uno]]. Also implementation of the [[Uno]] Remote Protocol. And in ooo-build a bridge from Mono to [[Uno]] and back.
|-
| [[canvas]] || new canvas implementation to improve rendering, various backends implement the new XCanvas API eg. cairo / DirectX
|-
| [[chart2]] || new, improved chart implementation, arrived in OO.o 2.3
|-
| [[Uno/CLI/Modules/cli_ure|cli_ure]] || '''C'''ommon '''L'''anguage '''I'''nfrastructure '''U'''no '''R'''untime '''E'''nvironment -- support assemblies and tools for the MS .Net (and Mono) [[Uno]] binding.
|-
| [[Uno/Binary/Module/codemaker|codemaker]] || [[Uno]] interface declaration/stub generators for [[Uno/Cpp|C++ Uno]] (headers), [[Uno/Java|Java Uno]] (class files), [[Uno/CLI|CLI (.Net / Mono) Uno]].
|-
| <div id="configmgr">[[configmgr]]</div> || the configuration database - UNO services and some tools
|-
| [[config_office]] || build configs, configure scripts, autotools, etc.
|-
| [[connectivity]] || database pieces, drivers, etc.
|-
| [[cosv]] || "Common Services," part of [[autodoc]]
|-
| [[cppcanvas]] || helper C++ classes for canvas, plus a GDIMetaFile-to-XCanvas converter
|-
| [[Uno/Binary/Module/CPPU|cppu]] || [[Uno/Binary|Binary (read 'C') Uno]] runtime.
|-
| [[Uno/Cpp/Module/CPPUhelper|cppuhelper]] || [[Uno/Cpp|C++ Uno]] runtime, additionally helpers e.g. templates for implementing Uno components, bootstrapping stuff etc. - get Uno up & running.
|-
| [[Uno/Binary/Module/CPPUtools|cpputools]] || [[Uno/Binary|Binary Uno]] tools, like uno.exe, regcomp etc.
|-
| [[crashrep]] || reports crashes (Novell disabled that)
|-
| [[curl]] || external library [http://curl.haxx.se curl] (a URL manipulation engine)
|-
| [[dbaccess]] || data base access tools
|-
| [[default_images]] || all images and resources
|-
| [[desktop]] || what used to be the desktop in SO5 - now the binary
|-
| [[dmake]] || the dmake tool itself, built by running 'bootstrap' after configure
|-
| [[dtrans]] || clipboard abstraction - data transfer
|-
| [[embeddedobj]] || Embedding objects
|-
| [[embedserv]] || Embed OOo through OLE2
|-
| [[epm]] || enhanced package manager- nasty hack for packaging
* not useful - but default build uses, every linux packager disables this
|-
| [[eventattacher]] || how basic handles events -
|-
| [[expat]] || external library with added UCS2 support, ... simple SAX parser
|-
| [[extensions_(source_code_module)|extensions]] || browser plugin, activex control, scanner bits
|-
| [[external]] || placeholder for extra code needed to build
|-
| [[extras]] || templates, clipart galleries, palettes, symbol font etc.
|-
| [[fileaccess]] || tiny: implements XSimpleFileAccess interface - that makes the UCB interfaces actually usable (via [[Uno]]) and more intuitive.
|-
| [[filter]] || filter registration and some simple filters (also descriptions
|-
| [[forms]] || embedded forms control and pieces (design forms in documents, fields and database driven)
|-
| [[fpicker]] || native file pickers for Unix and Windows (file open dialog) GTK+, KDE, Windows
|-
| [[Framework]] || UI rewrite, toolbars, menus, [[Uno]] stuff, including accelerators & interaction, etc.
|-
| [[External/Modules/freetype|freetype]] || Font rasterrizer.
|-
| [[goodies]] || graphics filters, 3d and 2d graqphics pieces
|-
| [[helpcontent2]] || for OpenOffice.org 2 - english + other languages help content
|-
| [[hsqldb]] || external library. http://hsqldb.org/ Java database engine. Default database format for OpenOffice.org
|-
| [[hwpfilter]] || filter for a word processor file format popular in Korea. (Hangul Word Processor)
|-
| [[i18npool]] || internationalization, counting, calendaring, complex text layout
|-
| [[i18nutil]] || small bits of internationalization
|-
| [[ICU|icu]] || external library. International (IBM? ;-)) Components for Unicode, http://icu.sourceforge.net/ with patches.
|-
| [[idl]] || SvIDL Compiler
|-
| [[Uno/Binary/Module/idlc|idlc]] || The [[Uno/Specifications/IDL|Uno IDL]] compiler.
|-
| [[instsetoo_native]] || install set for oo, native installers -
|-
| [[Util/Module/IO|io]] || Provides socket and pipe acceptors / connectors, as well as text input / output streams.
|-
| [[Uno/Java/Module/javaunohelper|javaunohelper]] || [[Uno/Java|Java Uno]] components implementation helpers.
|-
| [[Uno/Java/Module/JURT|jurt]] || '''J'''ava '''U'''no '''R'''un'''t'''ime - Basically [[Uno/Java|Java Uno]].
|-
| [[Util/Module/JUT|jut]] || '''J'''ava '''U'''no '''T'''ools - Tools for [[Uno/Java|Java Uno]].
|-
| [[jvmaccess]], [[jvmfwk]] || wrappers so you can use all the Java Runtime Environments with their slightly incompatible APIs with ease. Hah.
|-
| [[libwpd]] || external library. Not modified. http://libwpd.sourceforge.net/ wordperfect filter - SAX api - emits callbacks when things happen
|-
| [[libxmlsec]] || external library. (Still) heavily patched. http://www.aleksey.com/xmlsec/ to do XML signing, etc.
|-
| [[lingucomponent]] || spellcheck, hyphenator, thesaurus, ...
|-
| [[linguistic]] || This component manages all registered linguistic module implementations for spellchecker, hyphenator and thesaurus.
|-
| [[lpsolve]] || external library that provides a mixed integer linear programming (MILP) solver, see http://lpsolve.sourceforge.net
|-
| [[mathmldtd]] || MathMLDTD to implement XML Math format, see http://www.w3.org/TR/REC-MathML
|-
| [[msfontextract]] || external library. http://www.kyz.uklinux.net/libmspack/ for use in FontOOo (unpacking the downloaded Microsoft fonts (webfont))
|-
| [[nas]] || The Network Audio System (NAS), An Audio Protocol For Networks. See http://radscan.com/nas.html
|-
| [[neon]] || web library to help deal with WebDAV or other protocols
|-
| [[netbeans_integration]] || java?
|-
| [[np_sdk]] || Netscape Plugin SDK. Header to build Mozilla plugins.
|-
| [[odk]] || office development kit - implements the first step on the way to the OpenOffice.org SDK tarball
|-
| [[offapi]] || all of the [[Uno/Specification/IDL|Uno IDL]] files except those in [[#udkapi|udkapi]] - i.e. the interfaces that are specific to the OpenOffice.org application.
|-
| [[officecfg]] || the schema and default settings for the [[#configmgr|OpenOffice.org configuration database]]
|-
| [[offuh]] || Tiny module to build the generate the [[Uno/Cpp|C++ Uno]] headers.
|-
| [[oocustomimages]] || themes, custom themes
|-
| [[OOX|oox]] || OpenXML parser
|-
| [[packages]] || reading and writing zips
|-
| [[padmin]] || printer administration dialog - used lpr - obsolete with CUPS and fontconfig, but still used for some things
|-
| [[External/Modules/portaudio|portaudio]] || an audio output library for various sound setups.
|-
| [[postprocess]] || Postprocessing and checking of files delivered by other modules. This module has to be the last one before creating install sets in module 'instset_native'.
|-
| [[psprint]] || postscript print - unix only - implements font discovery, interface to CUPS / lpr, query and basic PS - dump PS on print - actual PS rendering inside vcl
|-
| [[psprint_config]] || ppds for use by psprint when not using CUPS
|-
| [[pyuno]] || [[Uno]] binding for python
|-
| [[qadevOOo]] || qa testsuite
|-
| [[Uno/Binary/Module/rdbmaker|rdbmaker]] || makes registries for openoffice for storing type data, etc./?
|-
| [[readlicense_oo]] || reading oo license when starting up
|-
| [[regexp]] || regular expression matching
|-
| [[registry]] || registry reading, etc.
|-
| [[Uno/Binary/Module/remotebridges|remotebridges]] || [[Uno]] services dealing with interprocess bridges.
|-
| [[rhino]] || java script engine/interpreter
|-
| [[Uno/Java/Module/ridljar|ridljar]] || Generators [[Uno/Java|Java Uno]] types (like [[offuh]]).
|-
| [[rsc]] || resource compiler - turns resource descriptions src and hrc files scattered throughout.
|-
| [[rvpapi]] || Obsolete.
|-
| [[sablot]] || external library. yet another xslt implementation in the tree (in C++)
|-
| [[Porting/Module/SAL|sal]] || system abstraction layer - rtl, osl and sal (rtl - platform independent strings, osl - platform specific stuff, threads, dynamic loading, process, ipc, etc.). Exports only C API and some inline-methods-only C++ API
|-
| [[Uno/Cpp/Module/SALhelper|salhelper]] || C++ helpers to make use of sal easier
|-
| [[Util/Module/sandbox|sandbox]] || Generic sandboxing, e.g. used for Java applet embedding stuff. Totally useless without a Sun JDK. Might be obsolet.
|-
| [[sane]] || external scanner library
|-
| [[sax]] || wrapper around expat using [[Uno]].
|-
| [[sc]] || calc - the Spreadsheet core
|-
| [[scaddins]] || extra functions for calc
|-
| [[scp2]] || script particles - being rewritten for oo2. all of installation was driven by starbasic - this is now in instsetoo-native
|-
| [[scripting]] || scripting framework - for java, python, etc. to play together and uses UNO
|-
| [[scsolver]] || [[Optimization Solver]] for Calc
|-
| [[sd]] || Impress and Draw components. Think of Impress as hack on top of Draw.
|-
| [[sdext]] || Extensions for the Impress and Draw applications.
|-
| [[sdk_oo]] || software development kit OO - implements the second step on the way to the OpenOffice.org SDK tarball (see odk)
|-
| [[setup-native]] || ?
|-
| [[sfx2]] || gui code, much of which is now deprecated - list of documents open would be tracked - raw C++ code; gutsy core of document management and loading.
|-
| [[shell]] || system helpers - launching URI, recently used files, system integration, external mailer support, gconf integration etc.
|-
| [[sj2]] || Java Applet support.
|-
| [[slideshow]] || new impress slideshow engine in OO.o 2.0
|-
| [[smoketestoo_native]] ||
|-
| [[sndfile]] || soundfile - library for loading all kinds of sound - external lib
|-
| [[so3]] || StarObject (v3)
|-
| [[solenv]] || make and build infrastructure - solar (think: Sun or Star Division) environment
|-
| [[soltools]] || all sorts of build tools
|-
| [[solver]] || dumping ground for binaries as object output
|-
| [[sot]] || compound file storage tools code (?)
|-
| [[starmath]] || formula editor
|-
| [[External/Modules/stlport|stlport]] || external library. STL implementation, from the days when compilers had crappy implementations.
|-
| [[Uno/Binary/Module/STOC|stoc]] || Core Components for [[Uno/Binary|Binary Uno]] (e.g. registry access, reflection, introspection).
|-
| [[store]] || Storage implementations, used by [[Uno]] registries.
|-
| [[svtools]] || useful code, common dialogs, file and print dialogs, wizards, vcl filters, lots of helper code
|-
| [[svx]] || graphics related helper code - xoutdev - rendering - this is where a lot of wht work would happen to move to the canvas. svdraw - transparent gradient stuff . lots of the draw and impress code is in this shared lib
|-
| [[sw]] || writer - the word processing core
|-
| [[sysui]] || .desktop files for different distros
|-
| [[toolkit]] || abstract windowing thing- [[Uno]] imples of windows stuff - so can be used from basic
|-
| [[tools]] || predates sal - string etc . functions, url manip, stream stuff, polygons, etc.
|-
| [[transex3]] || translation tools
|-
| [[twain]] || Windows scanner support
|-
| [[ucb]] || '''U'''niversal '''C'''ontent '''B'''roker (has ucp) which do things like convert files to strings in content broker world.
|-
| [[ucbhelper]] || C++ wrappers to help make using content providers easy
|-
| <div id="udkapi">[[udkapi]]</div> || URE API definition - [[Uno/Specification/IDL|Uno IDL]] files
|-
| [[udm]] || part of [[autodoc]]
|-
| [[unixODBC]] || external lib
|-
| [[unocontrols]] || separate process and thread for progress bars, etc.
|-
| [[unoil]] || Like offuh for [[Uno/Java|Java Uno]] - Generates Java class files from OOo application Uno types.
|-
| [[unotools]] || helpers for C++ use of UNO
|-
| [[unoxml]] || [[Uno]] wrappers for XML services
|-
| [[unzip]] || used by installer
|-
| [[ure]] || beginnings of standalone UNO distribution foo.
|-
| [[uui]] || An Interaction Handler for the UCB. It uses VCL to visualize and handle interaction requests.
|-
| [[vcl]] || base windowing toolkit abstraction Visual Class Libraries, and graphical output layer - includes backends for unix & Win32
|-
| [[vigra]] || Template framework from [http://kogs-www.informatik.uni-hamburg.de/~koethe/vigra/ here]. VIGRA stands for "Vision with Generic Algorithms". Used from [[basebmp]].
|-
| [[vos]] || (virt obj system) - deprecated but still used, lots of sal like stuff
|-
| [[wizards]] || java wizards for db setup, importing, tutorials, etc.
|-
| [[writerperfect]] || word perfect filter - wrapper for libwpd
|-
| [[X11_extensions]] || headers for XRender support
|-
| [[xalan]] || external library. java xslt implementation
|-
| [[xmerge]] || The XMerge SDK provides a Java-based framework for converting documents between different formats using conversion plugins to read and write each format. See http://xml.openoffice.org/xmerge
|-
| [[xml2cmp]] || Comes with the OO SDK. xml2cmp is launched in general by a makefile to extract types from a xml file
|-
| [[xmlhelp]] || help reader and viewer for online help
|-
| [[xmloff]] || common xml import and export filter logic
|-
| [[xmlscript]] || ?
|-
| [[xmlSearch]] || ?"
|-
| [[xmlSecurity]] || document signing
|-
|}

[[Category:Source directories]]

Source code directories

2007-08-27T20:12:58Z

Hub: typos

Below is a (somewhat terse) description of the various directories for OpenOffice source code.

{| border="1"
| [[agg]] || antigrain geometry lib (from http://www.antigrain.com/), a software renderer used in canvas
|-
| [[animation]] || Containers for the css::animation UNO API, used in slideshow and sd
|-
| [[autodoc]] || html pages from c++, java, idl inline documentation
|-
| [[automation]] || Hook for QA automation (TestTool)
|-
| [[avmedia]] || Audio/Video media implementation - requires a working Java Media Framework (JMF)
* currently can't play streams only file-system URIs anyway.
|-
| [[basctl]] || controls and dialogs - basic
|-
| [[basebmp]] || algorithms and data types for bitmap graphics (e.g. line and fill polygon scan conversion, bitmap format iterators, and a SalGraphics-compatible software renderer)
|-
| [[basegfx]] || algorithms and data types for graphics (e.g. polygons, vectors, matrices and the like - see that used in canvas)
|-
| [[basic]] || basic interpreter
|-
| [[OOoBean|bean]] || office bean
|-
| [[beanshell]] || java interpreter - so you can write java in command shell,
* interactive java -- good for prototyping /macros
* from http://www.beanshell.org/ with some patches
|-
| [[berkeleydb]] || external library. http://www.sleepycat.com/products/db.shtml simple db - used for search in help and galleries
|-
| [[Framework/Modules/binfilter|binfilter]] || [[StarOffice]] 5.2 compatibility layer, the UI and everything. Basically a little SO 5.2 inside OO.o. This is huge - avoid building it by giving '--disable-binfilter' on the configure line.
|-
| [[boost]] || external (C++ template) library: http://boost.org/native
|-
| [[Uno/Binary/Module/bridges|bridges]] || Bridges from various C++ ABIs, Java JNI, MS .Net to [[Uno/Binary|Binary Uno]]. Also implementation of the [[Uno]] Remote Protocol. And in ooo-build a bridge from Mono to [[Uno]] and back.
|-
| [[canvas]] || new canvas implementation to improve rendering, various backends implement the new XCanvas API eg. cairo / DirectX
|-
| [[chart2]] || new, improved chart implementation, arrived in OO.o 2.3
|-
| [[Uno/CLI/Modules/cli_ure|cli_ure]] || '''C'''ommon '''L'''anguage '''I'''nfrastructure '''U'''no '''R'''untime '''E'''nvironment -- support assemblies and tools for the MS .Net (and Mono) [[Uno]] binding.
|-
| [[Uno/Binary/Module/codemaker|codemaker]] || [[Uno]] interface declaration/stub generators for [[Uno/Cpp|C++ Uno]] (headers), [[Uno/Java|Java Uno]] (class files), [[Uno/CLI|CLI (.Net / Mono) Uno]].
|-
| <div id="configmgr">[[configmgr]]</div> || the configuration database - UNO services and some tools
|-
| [[config_office]] || build configs, configure scripts, autotools, etc.
|-
| [[connectivity]] || database pieces, drivers, etc.
|-
| [[cosv]] || "Common Services," part of [[autodoc]]
|-
| [[cppcanvas]] || helper C++ classes for canvas, plus a GDIMetaFile-to-XCanvas converter
|-
| [[Uno/Binary/Module/CPPU|cppu]] || [[Uno/Binary|Binary (read 'C') Uno]] runtime.
|-
| [[Uno/Cpp/Module/CPPUhelper|cppuhelper]] || [[Uno/Cpp|C++ Uno]] runtime, additionally helpers e.g. templates for implementing Uno components, bootstrapping stuff etc. - get Uno up & running.
|-
| [[Uno/Binary/Module/CPPUtools|cpputools]] || [[Uno/Binary|Binary Uno]] tools, like uno.exe, regcomp etc.
|-
| [[crashrep]] || reports crashes (novell disabled that)
|-
| [[curl]] || external library [http://curl.haxx.se curl] (a URL manipulation engine)
|-
| [[dbaccess]] || data base access tools
|-
| [[default_images]] || all images and resources
|-
| [[desktop]] || what used to be the desktop in SO5 - now the binary
|-
| [[dmake]] || the dmake tool itself, built by running 'bootstrap' after configure
|-
| [[dtrans]] || clipboard abstraction - data transfer
|-
| [[embeddedobj]] || Embedding objects
|-
| [[embedserv]] || Embed OOo through OLE2
|-
| [[epm]] || enhanced package manager- nasty hack for packaging
* not useful - but default build uses, every linux packager disables this
|-
| [[eventattacher]] || how basic handles events -
|-
| [[expat]] || external library with added UCS2 support, ... simple SAX parser
|-
| [[extensions_(source_code_module)|extensions]] || browser plugin, activex control, scanner bits
|-
| [[external]] || placeholder for extra code needed to build
|-
| [[extras]] || templates, clipart galleries, palettes, symbol font etc.
|-
| [[fileaccess]] || tiny: implements XSimpleFileAccess interface - that makes the UCB interfaces actually usable (via [[Uno]]) and more intuitive.
|-
| [[filter]] || filter registration and some simple filters (also descriptions
|-
| [[forms]] || embedded forms control and pieces (design forms in documents, fields and database driven)
|-
| [[fpicker]] || native file pickers for Unix and Windows (file open dialog) GTK+, KDE, Windows
|-
| [[Framework]] || UI rewrite, toolbars, menus, [[Uno]] stuff, including accelerators & interaction, etc.
|-
| [[External/Modules/freetype|freetype]] || Font rasterrizer.
|-
| [[goodies]] || graphics filters, 3d and 2d graqphics pieces
|-
| [[helpcontent2]] || for OpenOffice.org 2 - english + other languages help content
|-
| [[hsqldb]] || external library. http://hsqldb.org/ Java database engine. Default database format for OpenOffice.org
|-
| [[hwpfilter]] || filter for a word processor file format popular in Korea. (Hangul Word Processor)
|-
| [[i18npool]] || internationalization, counting, calendaring, complex text layout
|-
| [[i18nutil]] || small bits of internationalization
|-
| [[ICU|icu]] || external library. International (IBM? ;-)) Components for Unicode, http://icu.sourceforge.net/ with patches.
|-
| [[idl]] || SvIDL Compiler
|-
| [[Uno/Binary/Module/idlc|idlc]] || The [[Uno/Specifications/IDL|Uno IDL]] compiler.
|-
| [[instsetoo_native]] || install set for oo, native installers -
|-
| [[Util/Module/IO|io]] || Provides socket and pipe acceptors / connectors, as well as text input / output streams.
|-
| [[Uno/Java/Module/javaunohelper|javaunohelper]] || [[Uno/Java|Java Uno]] components implementation helpers.
|-
| [[Uno/Java/Module/JURT|jurt]] || '''J'''ava '''U'''no '''R'''un'''t'''ime - Basically [[Uno/Java|Java Uno]].
|-
| [[Util/Module/JUT|jut]] || '''J'''ava '''U'''no '''T'''ools - Tools for [[Uno/Java|Java Uno]].
|-
| [[jvmaccess]], [[jvmfwk]] || wrappers so you can use all the Java Runtime Environments with their slightly incompatible APIs with ease. Hah.
|-
| [[libwpd]] || external library. Not modified. http://libwpd.sourceforge.net/ wordperfect filter - SAX api - emits callbacks when things happen
|-
| [[libxmlsec]] || external library. (Still) heavily patched. http://www.aleksey.com/xmlsec/ to do XML signing, etc.
|-
| [[lingucomponent]] || spellcheck, hyphenator, thesaurus, ...
|-
| [[linguistic]] || This component manages all registered linguistic module implementations for spellchecker, hyphenator and thesaurus.
|-
| [[lpsolve]] || external library that provides a mixed integer linear programming (MILP) solver, see http://lpsolve.sourceforge.net
|-
| [[mathmldtd]] || MathMLDTD to implement XML Math format, see http://www.w3.org/TR/REC-MathML
|-
| [[msfontextract]] || external library. http://www.kyz.uklinux.net/libmspack/ for use in FontOOo (unpacking the downloaded Microsoft fonts (webfont))
|-
| [[nas]] || The Network Audio System (NAS), An Audio Protocol For Networks. See http://radscan.com/nas.html
|-
| [[neon]] || web library to help deal with WebDAV or other protocols
|-
| [[netbeans_integration]] || java?
|-
| [[np_sdk]] || Netscape Plugin SDK. Header to build Mozilla plugins.
|-
| [[odk]] || office development kit - implements the first step on the way to the OpenOffice.org SDK tarball
|-
| [[offapi]] || all of the [[Uno/Specification/IDL|Uno IDL]] files except those in [[#udkapi|udkapi]] - i.e. the interfaces that are specific to the OpenOffice.org application.
|-
| [[officecfg]] || the schema and default settings for the [[#configmgr|OpenOffice.org configuration database]]
|-
| [[offuh]] || Tiny module to build the generate the [[Uno/Cpp|C++ Uno]] headers.
|-
| [[oocustomimages]] || themes, custom themes
|-
| [[OOX|oox]] || OpenXML parser
|-
| [[packages]] || reading and writing zips
|-
| [[padmin]] || printer administration dialog - used lpr - obsolete with CUPS and fontconfig, but still used for some things
|-
| [[External/Modules/portaudio|portaudio]] || an audio output library for various sound setups.
|-
| [[postprocess]] || Postprocessing and checking of files delivered by other modules. This module has to be the last one before creating install sets in module 'instset_native'.
|-
| [[psprint]] || postscript print - unix only - implements font discovery, interface to CUPS / lpr, query and basic PS - dump PS on print - actual PS rendering inside vcl
|-
| [[psprint_config]] || ppds for use by psprint when not using CUPS
|-
| [[pyuno]] || [[Uno]] binding for python
|-
| [[qadevOOo]] || qa testsuite
|-
| [[Uno/Binary/Module/rdbmaker|rdbmaker]] || makes registries for openoffice for storing type data, etc./?
|-
| [[readlicense_oo]] || reading oo license when starting up
|-
| [[regexp]] || regular expression matching
|-
| [[registry]] || registry reading, etc.
|-
| [[Uno/Binary/Module/remotebridges|remotebridges]] || [[Uno]] services dealing with interprocess bridges.
|-
| [[rhino]] || java script engine/interpreter
|-
| [[Uno/Java/Module/ridljar|ridljar]] || Generators [[Uno/Java|Java Uno]] types (like [[offuh]]).
|-
| [[rsc]] || resource compiler - turns resource descriptions src and hrc files scattered throughout.
|-
| [[rvpapi]] || Obsolete.
|-
| [[sablot]] || external library. yet another xslt implementation in the tree (in C++)
|-
| [[Porting/Module/SAL|sal]] || system abstraction layer - rtl, osl and sal (rtl - platform independent strings, osl - platform specific stuff, threads, dynamic loading, process, ipc, etc.). Exports only C API and some inline-methods-only C++ API
|-
| [[Uno/Cpp/Module/SALhelper|salhelper]] || C++ helpers to make use of sal easier
|-
| [[Util/Module/sandbox|sandbox]] || Generic sandboxing, e.g. used for Java applet embedding stuff. Totally useless without a Sun JDK. Might be obsolet.
|-
| [[sane]] || external scanner library
|-
| [[sax]] || wrapper around expat using [[Uno]].
|-
| [[sc]] || calc - the Spreadsheet core
|-
| [[scaddins]] || extra functions for calc
|-
| [[scp2]] || script particles - being rewritten for oo2. all of instalation was driven by starbasic - this is now in instsetoo-nativ
|-
| [[scripting]] || scripting framework - for java, python, etc. to play together and uses UNO - noel working on
|-
| [[scsolver]] || [[Optimization Solver]] for Calc
|-
| [[sd]] || impress and draw components . impress think as hack on top of draw.
|-
| [[sdext]] || Extensions for the Impress and Draw applications.
|-
| [[sdk_oo]] || software development kit OO - implements the second step on the way to the OpenOffice.org SDK tarball (see odk)
|-
| [[setup-native]] || ?
|-
| [[sfx2]] || gui code, much of which is now deprecated - list of documents open would be traceked - raw C__ code; gutsy core of document management and loading.
|-
| [[shell]] || system helpers - launching URI, recently used files, system integration, external mailer support, gconf integration etc.
|-
| [[sj2]] || Java Applet support.
|-
| [[slideshow]] || new impress slideshow engine in OO.o 2.0
|-
| [[smoketestoo_native]] ||
|-
| [[sndfile]] || soundfile - library for loading all kinds of sound - external lib
|-
| [[so3]] || StarObject (v3)
|-
| [[solenv]] || make and build infrastructure - solar (think: Sun or Star Division) environment
|-
| [[soltools]] || all sorts of build tools
|-
| [[solver]] || dumping ground for binaries as object output
|-
| [[sot]] || compound file storage tools code (?)
|-
| [[starmath]] || formula editor
|-
| [[External/Modules/stlport|stlport]] || external library. STL implementation, from the days when compilers had crappy implementations.
|-
| [[Uno/Binary/Module/STOC|stoc]] || Core Components for [[Uno/Binary|Binary Uno]] (e.g. registry access, reflection, introspection).
|-
| [[store]] || Storage implementations, used by [[Uno]] registries.
|-
| [[svtools]] || useful code, common dialogs, file and print dialogs, wizards, vcl filters, lots of helper code
|-
| [[svx]] || graphics related helper code - xoutdev - rendering - this is where a lot of wht work would happen to move to the canvas. svdraw - transparent gradient stuff . lots of the draw and impress code is in this shared lib
|-
| [[sw]] || writer - the word processing core
|-
| [[sysui]] || .desktop files for different distros
|-
| [[toolkit]] || abstract windowing thing- [[Uno]] imples of windows stuff - so can be used from basic
|-
| [[tools]] || predates sal - string etc . functions, url manip, stream stuff, polygons, etc.
|-
| [[transex3]] || translation tools
|-
| [[twain]] || Windows scanner support
|-
| [[ucb]] || '''U'''niversal '''C'''ontent '''B'''roker (has ucp) which do things like convert files to strings in content broker world.
|-
| [[ucbhelper]] || C++ wrappers to help make using content providers easy
|-
| <div id="udkapi">[[udkapi]]</div> || URE API definition - [[Uno/Specification/IDL|Uno IDL]] files
|-
| [[udm]] || part of [[autodoc]]
|-
| [[unixODBC]] || external lib
|-
| [[unocontrols]] || separate process and thread for progress bars, etc.
|-
| [[unoil]] || Like offuh for [[Uno/Java|Java Uno]] - Generates Java class files from OOo application Uno types.
|-
| [[unotools]] || helpers for C++ use of UNO
|-
| [[unoxml]] || [[Uno]] wrappers for XML services
|-
| [[unzip]] || used by installer
|-
| [[ure]] || beginnings of standalone UNO distribution foo.
|-
| [[uui]] || An Interaction Handler for the UCB. It uses VCL to visualize and handle interaction requests.
|-
| [[vcl]] || base windowing toolkit abstraction Visual Class Libraries, and graphical output layer - includes backends for unix & Win32
|-
| [[vigra]] || Template framework from [http://kogs-www.informatik.uni-hamburg.de/~koethe/vigra/ here]. VIGRA stands for "Vision with Generic Algorithms". Used from [[basebmp]].
|-
| [[vos]] || (virt obj system) - deprecated but still used, lots of sal like stuff
|-
| [[wizards]] || java wizards for db setup, importing, tutorials, etc.
|-
| [[writerperfect]] || word perfect filter - wrapper for libwpd
|-
| [[X11_extensions]] || headers for XRender support
|-
| [[xalan]] || external library. java xslt implementation
|-
| [[xmerge]] || The XMerge SDK provides a Java-based framework for converting documents between different formats using conversion plugins to read and write each format. See http://xml.openoffice.org/xmerge
|-
| [[xml2cmp]] || Comes with the OO SDK. xml2cmp is launched in general by a makefile to extract types from a xml file
|-
| [[xmlhelp]] || help reader and viewer for online help
|-
| [[xmloff]] || common xml import and export filter logic
|-
| [[xmlscript]] || ?
|-
| [[xmlSearch]] || ?"
|-
| [[xmlSecurity]] || document signing
|-
|}

[[Category:Source directories]]

CVS

2007-08-18T18:47:43Z

Hub: bonsai moved

== CVS ==

This page describes some difficulties with the modified CVS version, which is used for OpenOffice.org

=== FAQ ===

==== I can't checkout with a certain tag ====

OpenOffice.org CVS is loosing from time to time it's CVSROOT/valtags file so one needs to recreate this tags, this can be done by creating just another dummy branch:

cvs -d:pserver:mh@my-tunnel:/cvs co test
cd test/playground
cvs tag -b cws_src680_asyncdialogs2 Makefile

[[http://qa.openoffice.org/issues/show_bug.cgi?id=23306 IssueZilla 23306]]

==== how to track the patch code of a issue which has been fixed and integrated ? ====
(e.g) The issue 69010, belongs to the CWS impress110, has been integrated into m192.

there are two possibilties to track this:

1. Use EIS (eis.services.openoffice.org). Login into EIS, search for the impress110 cws and look there for the modules and files section. There you find the registered task and the files affected by this task. Following the link of the revision shows you the diff.
2. use bonsai (go-ooo.org/bonsai) to track all the changes of the cws (e.g. http://bonsai.go-oo.org/cvsquery.cgi?treeid=default&module=all&branch=cws_src680_impress110&branchtype=match&dir=&file=&filetype=match&who=&whotype=match&sortby=Date&hours=2&date=all&mindate=&maxdate=&cvsroot=%2Fhome%2Fooweb%2Fcvsup)
using the first alternative work fine once a cws has been integrated, the second alternative works fine before integration of the cws.

Speedprof

2007-08-17T15:35:34Z

Hub: added category

=== what is it ===

Speedprof is an LD_PRELOAD based itimer (or hard real-time, or builtin CPU timer) based snapshot profiler. It samples at regular intervals (tweakable by reading the code ;-) and then presents a rather sexy data mining view so you can wind back full stack information - what function called what and when, self & cumulative times down trace paths etc.

=== how to get it ===

Checkout 'memprof' from GNOME [http://developer.gnome.org/tools/svn.html SVN]:

svn co http://svn.gnome.org/svn/memprof/branches/sled-fixes/ memprof

=== install it ===

./autogen.sh
make
sudo make install

=== how to use it ===

speedprof ./soffice.bin -writer

Of course, the most useful mode is to use the 'reset' button - ie. get OO.o going to the state you're interested in. Hit reset - do something slow - hit 'Profile' and wander the trace.

=== downsides ===

* sometimes crashes the app - but hey, sometimes the app crashes under it's own steam too - hard to know whom to blame.
* doesn't work well with old systems (pre TLS / NPTL)
* doesn't like very long C++ symbols much - makes the columns somewhat unpleasant to use, needs some app tweakage.

[[Category:Developer_Tools]]

Speedprof

2007-08-17T15:33:31Z

Hub: gnome is in SVN now

OOXML Issues

2007-07-25T14:38:54Z

Hub: a few corrections

== Section break properties allowed in style? ==

Since sections breaks are paragraph properties the question is whether a sections break can really be applied using a style? In other words are the following style definitions valid?

<pre>
<w:style w:type="paragraph" w:customStyle="1" w:styleId="MyStyle">
<w:name w:val="MyStyle" />
<w:basedOn w:val="Normal" />
<w:pPr>
<w:sectPr>
<w:pgSz w:w="12240" w:h="15840" />
<w:pgMar w:top="1417" w:right="1417" w:bottom="1134" w:left="1417" w:header="708" w:footer="708" w:gutter="0" />
<w:cols w:space="708" />
<w:docGrid w:linePitch="360" />
</w:sectPr>
</w:pPr>
</w:style>
</pre>

The answer discussed in the TC was "no" --- section break properties should not appear in styles. So the schema needs to be fixed here.

== Merge consecutive tables? ==

Consecutive tables (tables which follow each other) are automatically merged (if they have the same style). The questions is whether this is a Word bug or actually intended (for backward compatibility this is the right behavior).

== Unicode BIDI algorithm. ==
Clarify how '''w:rtl''', '''w:ltr''' is related to the Unicode BIDI algorithm ([[http://unicode.org/reports/tr9/]]).

== Unicode Breaking Rules ==
Specify the line breaking rules used similar to [[http://unicode.org/reports/tr14/]], i.e. specify what wordWrap=”True” ( cf. 2.3.1.45 wordWrap (Allow Line Breaking At Character Level)) means. Fragments have already been described in “2.3.1.16 kinsoku (Use East Asian Typography Rules for First and Last Character per Line)”.

For example
<pre>
AAAAAAAAAAAAAAA %BBBBBBBBBBB
</pre>
will be displayed by WW as
<pre>
123456789.123456789.

AAAAAAAAAAAAAAA %BBB
BBBBBBBB
</pre>
whereas according to [[http://unicode.org/reports/tr14/]] the text should be (IMHO) displayed as
<pre>
123456789.123456789.

AAAAAAAAAAAAAAA %
BBBBBBBBBBB
</pre>

== Clarify character classes Complex (resp. Non-Complex), East Asian. ==
Clarify the Unicode ranges of the terms “Complex Script”, “Non-Complex Script” and “East Asian” script used in the OOXML spec.

== Clarify to which character classes w:b and w:bCS (and w:i resp. w:iCS, etc. ) is applied. ==
Especially it is not defined whether w:b or w:bCS will be applied to “shared characters”.

== WMF, EMF, EMF+ ==
Specify the WMF, EMF, EMF+ file formats. (I understand the argumentation of the TC that specifying graphics format is currently not in the scope of the TC --- however maybe this is an item for the future...)

== Graphics properties override ==
Sample...

== Keep-Next in tables ==
Sample...

== Evaluation order of DO/Shapes/etc. ==
Sample...

== Use printer metrics ==
It is specified what a turned-on compatibility option usePrinterMetrics means. It is yet unspecified which metrics are used when the compatibility option is turned-off.

== Specify Transitions (#403) ==
Currently the OpenXML specification, part 4, specify a "transition"
element in 4.4.1.46 for [[PresentationML]]. This transition element can contain 0
or 1 transition child elements, to define the transition itself, amongst
a list of 21. None of these 21 elements actually explain the visual
effect of the slide transition effect it describe.

The consequence is that with only the specification, it is impossible to
implement the slide transition effect, even approximately.

Something like this: [[http://www.w3.org/TR/2005/REC-SMIL2-20050107/smil-transitions.html#Table%201:%20Taxonomy%20Table]]

== Languages in field commands ==

Similar to problems already reported in Excel.

[[Category:Office Open XML]]

OOXML Issues

2007-07-25T14:32:29Z

Hub: added category

== Section break properties allowed in style? ==

Since sections breaks are paragraph properties the question is whether a sections break can really be applied using a style? In other words are the following style definitions valid?

<pre>
<w:style w:type="paragraph" w:customStyle="1" w:styleId="MyStyle">
<w:name w:val="MyStyle" />
<w:basedOn w:val="Normal" />
<w:pPr>
<w:sectPr>
<w:pgSz w:w="12240" w:h="15840" />
<w:pgMar w:top="1417" w:right="1417" w:bottom="1134" w:left="1417" w:header="708" w:footer="708" w:gutter="0" />
<w:cols w:space="708" />
<w:docGrid w:linePitch="360" />
</w:sectPr>
</w:pPr>
</w:style>
</pre>

The answer discussed in the TC was "no" --- section break properties should not appear in styles. So the schema needs to be fixed here.

== Merge consecutive tables? ==

Consecutive tables (tables which follow each other) are automatically merged (if they have the same style). The questions is whether this is a Word bug or actually intended (for backward compatibility this is the right behavior).

== Unicode BIDI algorithm. ==
Clarify how '''w:rtl''', '''w:ltr''' is related to the Unicode BIDI algorithm ([[http://unicode.org/reports/tr9/]]).

== Unicode Breaking Rules ==
Specify the line breaking rules used similar to [[http://unicode.org/reports/tr14/]], i.e. specify what wordWrap=”True” ( cf. 2.3.1.45 wordWrap (Allow Line Breaking At Character Level)) means. Fragments have already been described in “2.3.1.16 kinsoku (Use East Asian Typography Rules for First and Last Character per Line)”.

For example
<pre>
AAAAAAAAAAAAAAA %BBBBBBBBBBB
</pre>
will be displayed by WW as
<pre>
123456789.123456789.

AAAAAAAAAAAAAAA %BBB
BBBBBBBB
</pre>
whereas according to [[http://unicode.org/reports/tr14/]] the text should be (IMHO) displayed as
<pre>
123456789.123456789.

AAAAAAAAAAAAAAA %
BBBBBBBBBBB
</pre>

== Clarify character classes Complex (resp. Non-Complex), East Asian. ==
Clarify the Unicode ranges of the terms “Complex Script”, “Non-Complex Script” and “East Asian” script used in the OOXML spec.

== Clarify to which character classes w:b and w:bCS (and w:i resp. w:iCS, etc. ) is applied. ==
Especially it is not defined whether w:b or w:bCS will be applied to “shared characters”.

== WMF, EMF, EMF+ ==
Specify the WMF, EMF, EMF+ file formats. (I understand the argumentation of the TC that specifying graphics format is currently not in the scope of the TC --- however maybe this is an item for the future...)

== Graphics properties override ==
Sample...

== Keep-Next in tables ==
Sample...

== Evaluation order of DO/Shapes/etc. ==
Sample...

== Use printer metrics ==
It is specified what a turned-on compatibility option usePrinterMetrics means. It is yet unspecified which metrics are used when the compatibility option is turned-off.

== Specify Transitions (#403) ==
Currently the OpenXML specification, part 4, specify a "transition"
element in 4.4.1.46 for DrawingMl. This transition element can contain 0
or 1 transition child elements, to define the transition itself, amongst
a list of 21. None of these 21 elements actually explain the visual
effect of the slide transition effect it describe.

The consequence is that with only the specification, it is impossible to
implement the slide transition effect, even approximately.

Something like this: [[http://www.w3.org/TR/2005/REC-SMIL2-20050107/smil-transitions.html#Table%201:%20Taxonomy%20Table]]

== Languages in field commands ==

Similar to problems already reported in Excel.

[[Category:Office Open XML]]

Impress/Performance

2007-06-13T23:58:38Z

Hub: ooo-build is now in SVN

== pngperf cws ==

The slide sorter of [[Impress]] is quite slow in some situations. Many of these [[performance]] problems have to do with the load time of huge image files and with the work to downscale those images to the much smaller sizes needed for the slide previews. The [http://eis.services.openoffice.org/EIS2/cws.ShowCWS?Id=3074 CWS pngperf] utilizes the fact that some image formats were designed with this use case in mind. It also benefits from the much smaller memory footprint of preview images compared to the original size images. The CWS was started by hdu few months ago.

=== CWS status ===

The CWS pngperf will be in OOo 2.1. Of course it will be integrated into an earlier developer build (probably SRC680m184).

== Previews ==

PNG images can be saved in interlaced mode. This increases the file size a little but it allows to load preview image up to 64 times faster. Without it you can for example end with loading few megabytes image - only to compute a small preview containing 64x64 pixels. (see [http://www.libpng.org/pub/png/pngintro.html http://www.libpng.org/pub/png/pngintro.html] for interlaced example)

The JPEG image format contains data stored hierarchically and thus can even provide higher quality preview images than a naive downsampling of the original size image. For JPEGs that have been saved in "progressive mode" only a small part of the image file has to be read for previews.

The pngperf cws adds necessary API for loading images in preview mode.

== API ==

So far there is API for previews, but OOo doesn't use it yet.

There exist slidesorter-demo-* patches in ooo-build [http://svn.gnome.org/viewcvs/ooo-build/trunk/patches/src680/ http://svn.gnome.org/viewcvs/ooo-build/trunk/patches/src680/] to use pngperf API, but they have still some problems (such as impress sometimes showing preview quality images in slideshow presentation). There is problem with using that API, as Sun needs to keep API/ABI compatability, and thus it is now only possible to set parameters to png/jpeg loaders by static functions.

== Slide show load/save operations ==

Loading or saving a presentation document is slower in OpenOffice.org than Microsoft PowerPoint. Also, with many large images, OpenOffice.org consumes more memory and may crash.

== TODO: ==

* provide hints for more situations where big images are previewed
* many more optimizations are possible...
* make an extension to downsample large images (5megapixels is common from digital camera) to screen resolutions such as 1024x768 or 800x600
* add image downsampling to support to [[http://www.ooomacros.org/user.php#95976 Impress Photo Album Creator extension]]

[[Category:Impress issues]]
[[Category:Performance]]

DrawingML

2007-05-09T21:30:37Z

Hub:

DrawingML

2007-05-09T21:26:22Z

Hub:

DrawingML is the ML for graphics data in [[Office Open XML]].

It is used throughout the whole Office suite for graphics data like in [[PresentationML]] and [[WordprocessingML]]

== Data model ==

=== Shapes ===

oox::drawingml::Shape is the main data structure for the DrawingML. It will contain many XShape all created from the drawingml.

The class Shape, every hard shape attribute is stored there. The text will be stored in the shape.

=== Text ===

The class "TextListStyle" is storing style information
"TextParagraphProperties" for
each of the ten text paragraphs (also a aggregation list style that is
used for sub titles)

The "TextParagraphProperties" class is storing paragraph and character
properties.

[[Category:Office Open XML]]
[[Category:Impress]]

DrawingML

2007-05-09T21:25:55Z

Hub: more explanation from sj

PresentationML

2007-05-09T21:25:35Z

Hub: /* Slides */

PresentationML is the XML format used by Microsoft PowerPoint 2007 and that is part of the [[Office Open XML]] specification. It defines all the structure for the presentation related data. Pure graphic data (ie the content of the slide) is described using [[DrawingML]].

= Finding sample files =

Use google and look for "download pptx".

= Code organisation =

oox/source/ppt/ contain the [[PresentationML]] specific code for the importer as well as dealing with presentation specific data.

oox/source/drawingml is for [[DrawingML]]. Most of the slide content is actually [[DrawingML]].

== Data Model ==

=== Importer ===

The importer is the class PowerPointImport.

SlidePersistPtr mpActualSlidePersist;

The actual slide that is imported

std::map< rtl::OUString, oox::drawingml::ThemePtr > maThemes;

Storing every theme that is used so far, the theme is imported before the slide.

std::map< sal_uInt32, ::com::sun::star::uno::Reference< ::com::sun::star::animations::XAnimationNode > > maAnimNodesMap;

Map of the Animation nodes by idea. (might change)

std::vector< SlidePersistPtr > maDrawPages;

Access to every page loaded so far.

std::vector< SlidePersistPtr > maMasterPages;
std::vector< SlidePersistPtr > maNotesPages;

Master pages and notes.

=== Slides ===

SlidePersist is the class that contain the slide data, including reference to the associated theme and color scheme. It can be a slide, a master slide, note page or handout master.

com::sun::star::uno::Reference< com::sun::star::drawing::XDrawPage > mxPage;

(the corresponding page where the shapes are to be inserted)

oox::drawingml::ThemePtr mpThemePtr;

(the actual theme that is used for this page)

oox::drawingml::ClrSchemePtr mpClrSchemePtr;

(the local color scheme (if any))

SlidePersistPtr mpMasterPagePtr;

This is the masterpage of this slide, it is only set if this slide is not a master by itself

// and this is important for you, each slide is containing four TextListStyles,
// tilte, master, body and notes, the TextListStyle is storing information
// about the default paragraph/character formatting
oox::drawingml::TextListStylePtr maTitleTextStylePtr;
oox::drawingml::TextListStylePtr maBodyTextStylePtr;
oox::drawingml::TextListStylePtr maNotesTextStylePtr;
oox::drawingml::TextListStylePtr maOtherTextStylePtr;

so when importing a shape, we have access to the corresponding theme and
text styles.

See [[DrawingML]] for more information.

=== XModel ===

The objects itself are created in
SlideFragmentHandler::~SlideFragmentHandler

while( aIter != rShapes.end() )
(*aIter++)->addShape( mxFilter->getModel(), xShapes );

See [http://api.openoffice.org/docs/common/ref/com/sun/star/frame/XModel.html XModel].

=== Animation ===

Animation are heavily based on [[SMIL]], much like the internals of Impress. There are 3 parts: slide transition, slide timing and shape animations

==== Transitions ====

Transition in OOx and OpenDocument are not exactly the same but there is almost a 1 to 1 mapping. They are both based on [[SMIL]] transitions. See also: http://www.w3.org/TR/2005/REC-SMIL2-20050107/smil-transitions.html#Table%201:%20Taxonomy%20Table

* '''ID''': the XML token
* '''OOo Status''': '''Y'''es or '''N'''o.
* '''Type''': the type as defined in com/sun/star/animations/TransitionType.hpp
* '''SubType''': the type as defined in com/sun/star/animations/TransitionSubType.hpp

{|border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; background: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse;"
! PowerPoint 2007 Name || ID || Param || OOo Status || Type || Subtype || Note
|-
| blinds || blinds || vert || Y || BLINDSWIPE || VERTICAL
|-
| || || horz || Y || BLINDSWIPE || HORIZONTAL
|-
| checker || checker || vert || Y || CHECKERBOARDWIPE || VERTICAL
|-
| || || horz || Y || CHECKERBOARDWIPE || HORIZONTAL
|-
| comb || comb || vert || Y || PUSHWIPE || COMBVERTICAL
|-
| || || horz || Y || PUSHWIPE || COMBHORIZONTAL
|-
| cover || cover || || Y || SLIDEWIPE ||
|-
| pull || pull || || Y || SLIDEWIPE || (reversed)
|-
| cut || cut || || N || || || the bin filter ignore this too. the closest thing is not transition
|-
| cut || cut || thruBlk || N || FADE || FADEOVERCOLOR || will be slower than in PPT. But the binfilter ignore it too.
|-
| fade || fade || || Y || FADE || CROSSFADE
|-
| fade || fade || thruBlk || Y || FADE || FADEOVERCOLOR
|-
| push || push || d || Y || PUSHWIPE || FROMTOP
|-
| || || l || Y || PUSHWIPE || FROMLEFT
|-
| || || r || Y || PUSHWIPE || FROMRIGHT
|-
| || || u || Y || PUSHWIPE || FROMBOTTOM
|-
| wipe || wipe || d || Y || BARWIPE || FROMTOP
|-
| || || l || Y || BARWIPE || FROMLEFT
|-
| || || r || Y || BARWIPE || FROMRIGHT
|-
| || || u || Y || BARWIPE || FROMBOTTOM
|-
| split || split || || Y || BARNDOORWIPE || HORIZONTAL or VERTICAL (reverse for IN)
|-
| wheel || wheel || "1" || Y || PINWHEELWIPE || ONEBLADE
|-
| wheel || wheel || "2" || Y || PINWHEELWIPE || TWOBLADEVERTICAL
|-
| wheel || wheel || "3" || Y || PINWHEELWIPE || THREEBLADE
|-
| wheel || wheel || "4" || Y || PINWHEELWIPE || FOURBLADE
|-
| wheel || wheel || "8" || Y || PINWHEELWIPE || EIGHTBLADE
|-
| wheel || wheel || * || Y || PINWHEELWIPE || || the number is converted to 1, 2, 3, 4, 8 depending on the match. I don't see how to get different numbers from PPT2007
|-
| randomBar || randomBar || horz || Y || RANDOMBARWIPE || HORIZONTAL
|-
| randomBar || randomBar || vert || Y || RANDOMBARWIPE || VERTICAL
|-
| circle || circle || || Y || ELLIPSEWIPE || CIRCLE
|-
| diamond || diamond || || Y || IRISWIPE || DIAMOND
|-
| dissolve || dissolve || || Y || DISSOLVE || DEFAULT
|-
| newsflash || newsflash || || N || || || The binfilter ignore it too. It seems to use the previous transition instead. Or maybe it is just a coincidence that it is crossbar.
|-
| plus || plus || || Y || FOURBOXWIPE || CORNERSOUT ||
|-
| random || random || || Y || RANDOM || DEFAULT
|-
| wedge || wedge || || Y || FANWIPE || CENTERTOP
|-
| zoom || zoom || || Y || ZOOM || DEFAULT || Couldn't find it in PPT
|-
|}

There are also some limitations: OOo does not seem to support "stopping sound". Neither does it support embedded sound (see below).

==== Timing ====

==== Shape Animations ====

==== Limitations ====

[[Office Open XML]] specify that sound can be embedded in the file (in the container) and use relationships to refer to it. Unfortunately as of today OpenOffice is unable to do so. To that effect sounds are copied in the gallery and opened from there. For standard built-in sound, just refer to it. For none built-in sound, discard it.

[[Category:Office Open XML]]
[[Category:Impress]]

PresentationML

2007-05-09T21:25:07Z

Hub: more explanation from sj

PresentationML is the XML format used by Microsoft PowerPoint 2007 and that is part of the [[Office Open XML]] specification. It defines all the structure for the presentation related data. Pure graphic data (ie the content of the slide) is described using [[DrawingML]].

= Finding sample files =

Use google and look for "download pptx".

= Code organisation =

oox/source/ppt/ contain the [[PresentationML]] specific code for the importer as well as dealing with presentation specific data.

oox/source/drawingml is for [[DrawingML]]. Most of the slide content is actually [[DrawingML]].

== Data Model ==

=== Importer ===

The importer is the class PowerPointImport.

SlidePersistPtr mpActualSlidePersist;

The actual slide that is imported

std::map< rtl::OUString, oox::drawingml::ThemePtr > maThemes;

Storing every theme that is used so far, the theme is imported before the slide.

std::map< sal_uInt32, ::com::sun::star::uno::Reference< ::com::sun::star::animations::XAnimationNode > > maAnimNodesMap;

Map of the Animation nodes by idea. (might change)

std::vector< SlidePersistPtr > maDrawPages;

Access to every page loaded so far.

std::vector< SlidePersistPtr > maMasterPages;
std::vector< SlidePersistPtr > maNotesPages;

Master pages and notes.

=== Slides ===

SlidePersist is the class that contain the slide data, including reference to the associated theme and color scheme. It can be a slide, a master slide, note page or handout master.

com::sun::star::uno::Reference< com::sun::star::drawing::XDrawPage > mxPage;

(the corresponding page where the shapes are to be inserted)

oox::drawingml::ThemePtr mpThemePtr;

(the actual theme that is used for this page)

oox::drawingml::ClrSchemePtr mpClrSchemePtr;

(the local color scheme (if any))

SlidePersistPtr mpMasterPagePtr;

This is the masterpage of this slide, it is only set if this slide is not a master by itself

// and this is important for you, each slide is containing four TextListStyles,
// tilte, master, body and notes, the TextListStyle is storing information
// about the default paragraph/character formatting
oox::drawingml::TextListStylePtr maTitleTextStylePtr;
oox::drawingml::TextListStylePtr maBodyTextStylePtr;
oox::drawingml::TextListStylePtr maNotesTextStylePtr;
oox::drawingml::TextListStylePtr maOtherTextStylePtr;

so when importing a shape, we have access to the corresponding theme and
text styles.

=== XModel ===

The objects itself are created in
SlideFragmentHandler::~SlideFragmentHandler

while( aIter != rShapes.end() )
(*aIter++)->addShape( mxFilter->getModel(), xShapes );

See [http://api.openoffice.org/docs/common/ref/com/sun/star/frame/XModel.html XModel].

=== Animation ===

Animation are heavily based on [[SMIL]], much like the internals of Impress. There are 3 parts: slide transition, slide timing and shape animations

==== Transitions ====

Transition in OOx and OpenDocument are not exactly the same but there is almost a 1 to 1 mapping. They are both based on [[SMIL]] transitions. See also: http://www.w3.org/TR/2005/REC-SMIL2-20050107/smil-transitions.html#Table%201:%20Taxonomy%20Table

* '''ID''': the XML token
* '''OOo Status''': '''Y'''es or '''N'''o.
* '''Type''': the type as defined in com/sun/star/animations/TransitionType.hpp
* '''SubType''': the type as defined in com/sun/star/animations/TransitionSubType.hpp

{|border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; background: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse;"
! PowerPoint 2007 Name || ID || Param || OOo Status || Type || Subtype || Note
|-
| blinds || blinds || vert || Y || BLINDSWIPE || VERTICAL
|-
| || || horz || Y || BLINDSWIPE || HORIZONTAL
|-
| checker || checker || vert || Y || CHECKERBOARDWIPE || VERTICAL
|-
| || || horz || Y || CHECKERBOARDWIPE || HORIZONTAL
|-
| comb || comb || vert || Y || PUSHWIPE || COMBVERTICAL
|-
| || || horz || Y || PUSHWIPE || COMBHORIZONTAL
|-
| cover || cover || || Y || SLIDEWIPE ||
|-
| pull || pull || || Y || SLIDEWIPE || (reversed)
|-
| cut || cut || || N || || || the bin filter ignore this too. the closest thing is not transition
|-
| cut || cut || thruBlk || N || FADE || FADEOVERCOLOR || will be slower than in PPT. But the binfilter ignore it too.
|-
| fade || fade || || Y || FADE || CROSSFADE
|-
| fade || fade || thruBlk || Y || FADE || FADEOVERCOLOR
|-
| push || push || d || Y || PUSHWIPE || FROMTOP
|-
| || || l || Y || PUSHWIPE || FROMLEFT
|-
| || || r || Y || PUSHWIPE || FROMRIGHT
|-
| || || u || Y || PUSHWIPE || FROMBOTTOM
|-
| wipe || wipe || d || Y || BARWIPE || FROMTOP
|-
| || || l || Y || BARWIPE || FROMLEFT
|-
| || || r || Y || BARWIPE || FROMRIGHT
|-
| || || u || Y || BARWIPE || FROMBOTTOM
|-
| split || split || || Y || BARNDOORWIPE || HORIZONTAL or VERTICAL (reverse for IN)
|-
| wheel || wheel || "1" || Y || PINWHEELWIPE || ONEBLADE
|-
| wheel || wheel || "2" || Y || PINWHEELWIPE || TWOBLADEVERTICAL
|-
| wheel || wheel || "3" || Y || PINWHEELWIPE || THREEBLADE
|-
| wheel || wheel || "4" || Y || PINWHEELWIPE || FOURBLADE
|-
| wheel || wheel || "8" || Y || PINWHEELWIPE || EIGHTBLADE
|-
| wheel || wheel || * || Y || PINWHEELWIPE || || the number is converted to 1, 2, 3, 4, 8 depending on the match. I don't see how to get different numbers from PPT2007
|-
| randomBar || randomBar || horz || Y || RANDOMBARWIPE || HORIZONTAL
|-
| randomBar || randomBar || vert || Y || RANDOMBARWIPE || VERTICAL
|-
| circle || circle || || Y || ELLIPSEWIPE || CIRCLE
|-
| diamond || diamond || || Y || IRISWIPE || DIAMOND
|-
| dissolve || dissolve || || Y || DISSOLVE || DEFAULT
|-
| newsflash || newsflash || || N || || || The binfilter ignore it too. It seems to use the previous transition instead. Or maybe it is just a coincidence that it is crossbar.
|-
| plus || plus || || Y || FOURBOXWIPE || CORNERSOUT ||
|-
| random || random || || Y || RANDOM || DEFAULT
|-
| wedge || wedge || || Y || FANWIPE || CENTERTOP
|-
| zoom || zoom || || Y || ZOOM || DEFAULT || Couldn't find it in PPT
|-
|}

There are also some limitations: OOo does not seem to support "stopping sound". Neither does it support embedded sound (see below).

==== Timing ====

==== Shape Animations ====

==== Limitations ====

[[Office Open XML]] specify that sound can be embedded in the file (in the container) and use relationships to refer to it. Unfortunately as of today OpenOffice is unable to do so. To that effect sounds are copied in the gallery and opened from there. For standard built-in sound, just refer to it. For none built-in sound, discard it.

[[Category:Office Open XML]]
[[Category:Impress]]

Office Open XML/Legacy Implementation

2007-05-01T15:17:37Z

Hub: /* OOXML Basics */

= OOXML Basics =

"Office Open XML" is an XML based file format that has been published as [http://www.ecma-international.org/publications/standards/Ecma-376.htm ECMA-376]. It is used as default file format by Microsoft Office 2007.

There are plans to support this file format in OpenOffice.org for interoperate with Microsoft Office 2007.

There are 3 major types of formats

* [[WordprocessingML]] - For word processor documents (file extensions may be docx, docm)
* [[SpreadsheetML]] - For spreadsheet documents (file extensions may be xlsx, xlsm)
* [[PresentationML]] - For presentation documents (file extensions may be pptx, pptm)
* [[DrawingML]] - Used by other markup language to represent graphics data.
* [[VML]] - A legacy vector markup.

== Packaging Conventions ==
OpenXML document is a package that consists of a flat collection of '''"parts"'''. Each "part" has a case-''insensitive'' part name that consists of a slash (/) delimited sequence of segment names such as "/pres/slides/slide1.xml".

For the most part, the ZIP compression is used to package the parts, in which case the term '''"package"''' refers to the ZIP archive, and the parts refer to the individual files archived within. The part name in this case is the file path within the archive.

Each part also has a '''content type''', and '''/[Content_Types].xml''' provides the content type of each part within the archive.

== Relationships ==
Packages and parts can contains '''explicit relationships''' to other parts as well as to external resources. Every explicit relationship has an ID and a type, and relationship types are named using URIs.

The set of explicit relationships for each package or part is stored in a relationship part whose name (or path) follows a specific convention e.g. the relationship part for a part called '''"/a/b/c.xml"''' is called '''"/a/b/_rels/c.xml.rels"'''. As a special case, the relationship part for the package as a whole is called '''"/_rels/.rels"'''.

= OO.o Implementation =
There is some code in the oox module ([[OOX]]) from the [[Xml]] project. The [[CWS]] is xmlfilter02 in SRC680. ([http://eis.services.openoffice.org/EIS2/cws.ShowCWS?Path=SRC680%2Fxmlfilter02 view the workspace on EIS])

To fetch the oox code from CVS (using CVS_ROOT is set properly):

cvs co -r cws_src680_xmlfilter02 -d oox xml/oox

One important note: we use the term '''fragment''' in the name of our source files to correspond with what the standard calls '''part'''. For instance, the source file that contains class definition that handles the workbook part in SpreadsheetML is called workbookfragment.cxx. This convention is prevalent across all application types within [[oox]] module.

Bonsai is also convenient to follow the changes:

[http://www.go-oo.org/bonsai/cvsquery.cgi?treeid=default&module=all&branch=cws_src680_xmlfilter02&branchtype=match&dir=xml%2Foox&file=&filetype=match&who=&whotype=match&sortby=Date&hours=2&date=week&mindate=&maxdate=&cvsroot=%2Fvar%2Fcvsup the changes done in the last 2 weeks]

== Implementation Generalities ==

The whole [[OOX]] filter makes use of the new [[FastParser]] service to implement an event driven [[SAX]] parser.

== Various Resources ==

* http://blogs.sun.com/GullFOSS/entry/office_open_xml_import_filter
* [http://eis.services.openoffice.org/EIS2/cws.ShowCWS?Path=SRC680%2Fxmlfilter02 CWS on EIS]
* [http://www.ecma-international.org/publications/standards/Ecma-376.htm ECMA published standard]
* [http://www.ecma-international.org/news/TC45_current_work/TC45_available_docs.htm Ecma Office Open XML File Formats Standard]
* [http://blogs.msdn.com/brian_jones/archive/2005/06/20/430892.aspx Brian Jones introduction to the Office 12 File Format]

[[Category:Office Open XML]]

Oox

2007-05-01T15:16:59Z

Hub:

Stands for [[Office Open XML]]. The name of the module that handle [[Office Open XML]] import. Part of the [[Xml]] project.

= Note =

The [[WordprocessingML]] importer is part of a different effort in writerfilter2 where the refactoring of the binary and RTF filter also takes place.

= Directory Structure =
== core ==
This directory includes common code for all filters.

=== AttributeList (class) ===
Provides access to attribute values of an element. '''AttributeList''' wraps a ''com.sun.star.xml.sax.XFastAttributeList'' object, and provides convenience functions that convert the string value of an attribute to various other data types. This class is usually used as a local variable declared with an instance of [[XFastAttributeList]] passed from the [[FastParser]] instance.

=== FragmentHandler (class) ===
Top-most parent class that handles fragments. In most cases this class handles all nested contexts for increased performance. This class implements [[XFastDocumentHandler]] interface.

=== RelationsFragmentHandler (class) ===
Handles loading of relationships fragments ( '''/*/_rels/*.rels''' ). Like the FragmentHandler class, this class also implements [[XFastDocumentHandler]] interface.

=== ImportBase (class) ===
The base class for application specific import filters, currently sub-classed by '''oox::ppt::PowerPointImport''' and '''oox::xls::ExcelFilter'''. It implements [http://api.openoffice.org/docs/common/ref/com/sun/star/document/XImporter.html XImporter] and [http://api.openoffice.org/docs/common/ref/com/sun/star/document/XFilter.html XFilter] interfaces.

== drawingml ==
== ppt ==

ppt contain the [[PresentationML]] parsing code.

== token ==

The token list is generated by parsing the XML Schemas. Then gentoken.pl will use gperf to generate a perfect hash for fast parsing of known tokens. All the token are dispatched through integer numbers.

== xls ==
This directory includes code specific to parse [[SpreadsheetML]].

[[Category:Office Open XML]]
[[Category:Source_directories]]

Export filter framework

2007-05-01T15:15:09Z

Hub:

The best thing to do in order to have a good understanding of what OO.o does when you save or export a file is to read the relevant code. A good place to start would be the '''SfxObjectShell::SaveTo_Impl(...)''' method in '''sfx2/source/doc/objstor.cxx'''. This method depicts the overall flow of the file save / file export operation, so reading that code will give you a good overview of the process. Beware, though, that the SaveTo_Impl method has roughly ''600-lines of code'' in it. So, tracing the code there will probably drain a lot of your energy. Take a lot of vitamin before you start! :-)

The basic export framework is set by class '''SfxObjectShell''', which is sub-classed by the document shell class of each application (Writer, Calc and Draw/Impress) to implement several virtual functions of SfxObjectShell. Class '''SfxMedium''' represents the document to be saved, and class '''SfxFilter''' represents the filter that saves the document.

The export process also makes the following distinction.

* Native OO.o format (such as ODF) - call '''SfxObjectShell::SaveAsOwnFormat(...)'''
* Non-native, "alien" format - call '''SfxObjectShell::ExportTo(...)''' or '''SfxObjectShell::ConvertTo(...)''', the latter being a virtual function that is overwritten by each application.

= Export to external (alien) format =
This probably covers the vast majority of the export filters. The main flow moves to either '''ExportTo(...)''' in SfxObjectShell, or '''ConvertTo(...)''' in the same class. ConvertTo(...) is a virtual function overwritten by the current application's document shell class; '''ScDocShell''' for Calc, '''SwDocShell''' for Writer, and '''sd::DrawDocShell''' for Draw/Impress. The distinction between these two calls is unclear; it is differentiated based on whether or not the filter has flag <code>SFX_FILTER_STARONEFILTER</code>, but it's not clear what that flag means.

== Zip-based package format ==
TODO: fill it.

[[Category: Office Open XML]]

PresentationML

2007-04-20T21:01:03Z

Hub: final polish of transition list

PresentationML is the XML format used by Microsoft PowerPoint 2007 and that is part of the [[Office Open XML]] specification. It defines all the structure for the presentation related data. Pure graphic data (ie the content of the slide) is described using [[DrawingML]].

= Finding sample files =

Use google and look for "download pptx".

= Code organisation =

oox/source/ppt/ contain the [[PresentationML]] specific code for the importer as well as dealing with presentation specific data.

oox/source/drawingml is for [[DrawingML]]. Most of the slide content is actually [[DrawingML]].

== Data Model ==

SlidePersist is the class that contain the slide data, including reference to the associated theme and color scheme. It can be a slide, a master slide, note page or handout master.

It is all stored in some way in a [http://api.openoffice.org/docs/common/ref/com/sun/star/frame/XModel.html XModel].

=== Animation ===

Animation are heavily based on [[SMIL]], much like the internals of Impress. There are 3 parts: slide transition, slide timing and shape animations

==== Transitions ====

Transition in OOx and OpenDocument are not exactly the same but there is almost a 1 to 1 mapping. They are both based on [[SMIL]] transitions. See also: http://www.w3.org/TR/2005/REC-SMIL2-20050107/smil-transitions.html#Table%201:%20Taxonomy%20Table

* '''ID''': the XML token
* '''OOo Status''': '''Y'''es or '''N'''o.
* '''Type''': the type as defined in com/sun/star/animations/TransitionType.hpp
* '''SubType''': the type as defined in com/sun/star/animations/TransitionSubType.hpp

{|border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; background: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse;"
! PowerPoint 2007 Name || ID || Param || OOo Status || Type || Subtype || Note
|-
| blinds || blinds || vert || Y || BLINDSWIPE || VERTICAL
|-
| || || horz || Y || BLINDSWIPE || HORIZONTAL
|-
| checker || checker || vert || Y || CHECKERBOARDWIPE || VERTICAL
|-
| || || horz || Y || CHECKERBOARDWIPE || HORIZONTAL
|-
| comb || comb || vert || Y || PUSHWIPE || COMBVERTICAL
|-
| || || horz || Y || PUSHWIPE || COMBHORIZONTAL
|-
| cover || cover || || Y || SLIDEWIPE ||
|-
| pull || pull || || Y || SLIDEWIPE || (reversed)
|-
| cut || cut || || N || || || the bin filter ignore this too. the closest thing is not transition
|-
| cut || cut || thruBlk || N || FADE || FADEOVERCOLOR || will be slower than in PPT. But the binfilter ignore it too.
|-
| fade || fade || || Y || FADE || CROSSFADE
|-
| fade || fade || thruBlk || Y || FADE || FADEOVERCOLOR
|-
| push || push || d || Y || PUSHWIPE || FROMTOP
|-
| || || l || Y || PUSHWIPE || FROMLEFT
|-
| || || r || Y || PUSHWIPE || FROMRIGHT
|-
| || || u || Y || PUSHWIPE || FROMBOTTOM
|-
| wipe || wipe || d || Y || BARWIPE || FROMTOP
|-
| || || l || Y || BARWIPE || FROMLEFT
|-
| || || r || Y || BARWIPE || FROMRIGHT
|-
| || || u || Y || BARWIPE || FROMBOTTOM
|-
| split || split || || Y || BARNDOORWIPE || HORIZONTAL or VERTICAL (reverse for IN)
|-
| wheel || wheel || "1" || Y || PINWHEELWIPE || ONEBLADE
|-
| wheel || wheel || "2" || Y || PINWHEELWIPE || TWOBLADEVERTICAL
|-
| wheel || wheel || "3" || Y || PINWHEELWIPE || THREEBLADE
|-
| wheel || wheel || "4" || Y || PINWHEELWIPE || FOURBLADE
|-
| wheel || wheel || "8" || Y || PINWHEELWIPE || EIGHTBLADE
|-
| wheel || wheel || * || Y || PINWHEELWIPE || || the number is converted to 1, 2, 3, 4, 8 depending on the match. I don't see how to get different numbers from PPT2007
|-
| randomBar || randomBar || horz || Y || RANDOMBARWIPE || HORIZONTAL
|-
| randomBar || randomBar || vert || Y || RANDOMBARWIPE || VERTICAL
|-
| circle || circle || || Y || ELLIPSEWIPE || CIRCLE
|-
| diamond || diamond || || Y || IRISWIPE || DIAMOND
|-
| dissolve || dissolve || || Y || DISSOLVE || DEFAULT
|-
| newsflash || newsflash || || N || || || The binfilter ignore it too. It seems to use the previous transition instead. Or maybe it is just a coincidence that it is crossbar.
|-
| plus || plus || || Y || FOURBOXWIPE || CORNERSOUT ||
|-
| random || random || || Y || RANDOM || DEFAULT
|-
| wedge || wedge || || Y || FANWIPE || CENTERTOP
|-
| zoom || zoom || || Y || ZOOM || DEFAULT || Couldn't find it in PPT
|-
|}

There are also some limitations: OOo does not seem to support "stopping sound". Neither does it support embedded sound (see below).

==== Timing ====

==== Shape Animations ====

==== Limitations ====

[[Office Open XML]] specify that sound can be embedded in the file (in the container) and use relationships to refer to it. Unfortunately as of today OpenOffice is unable to do so. To that effect sounds are copied in the gallery and opened from there. For standard built-in sound, just refer to it. For none built-in sound, discard it.

[[Category:Office Open XML]]
[[Category:Impress]]

PresentationML

2007-04-20T19:04:28Z

Hub: more transitions