NeoLight

From NeoWiki

(Difference between revisions)
Jump to: navigation, search
Revision as of 19:37, 8 October 2005 (edit)
Vova83 ( | contribs)

← Previous diff		 Revision as of 00:52, 9 October 2005 (edit) (undo)
Sardisson (Talk | contribs)
m (Reverted edit of Vova83, changed back to last version by OPENSTEP)
Next diff →
Line 1: Line 1:
 +=NeoLight=
 +Edward Peterlin
 +Authored: 4/29/05
 +Revised: 10/02/05
 +==What is NeoLight?==
 +NeoLight is an abbreviation I've come up with for "NeoOffice Spotlight Importer". This importer allows [http://www.apple.com/macosx/features/spotlight/ Spotlight] to index metadata and content within the files created by NeoOffice. Through Spotlight integration, searching across multiple NeoOffice documents can be done in a nice, Mac-like fashion.
- <div id="wikitikitavi" style="overflow:auto; height: 1px; ">+Today is the first development release of the NeoLight plugin. This release aims to be the start of an addition that will be included with future builds of NeoOffice/J. The purposes of this release are:
- [[http://WTHP1.coolhost.biz] [WTHPD1]]+ 
- [http://WTHP2.coolhost.biz WTHPD2]+# Allow testers who have Tiger to begin assessing the utility of the plugin.
- [[http://WTHP3.coolhost.biz | WTHPD3]]+# Allow developers access to the source code to bugfix and improve the plugin.
- [http://WTHP4.coolhost.biz | WTHPD4]+# Research what other types of metadata may wish to be extracted from documents.
- [WTHPD5 | http://WTHP5.coolhost.biz]+# Get people excited enough to help add support for OpenDocument formatted documents.
- [[http://WTHP6.coolhost.biz WTHPD6]]+ 
- </div>+==Licensing==
 + 
 +NeoLight is being released under the GNU Lesser General Public License. While I would have preferred to use a GPL-style license like the main NeoOffice project, LGPL is necessary in this case as the Spotlight importers are shared libraries loaded into closed-source applications. Using LGPL allows for the executable code of NeoLight to be used by Spotlight without "infecting" Mac OS X with GPL requirements.
 + 
 +==Installation Requirements==
 + 
 +* Mac OS X 10.4 "Tiger"
 +* NeoOffice/J (or OpenOffice.org X11...see below)
 + 
 +==Downloading==
 + 
 +The NeoLight plugin can be downloaded as a single installer package:
 + 
 +http://trinity.neooffice.org/downloads/neolight_installer.pkg.tgz
 +*40K in size
 +* Latest Version : 1.1
 +* MD5 sum : 34339a63668f56caadb8dfde6f65223a
 +* Last updated 10/2/05 12:29 PST
 +** ''most recent update for OpenDocument support, x86 support''
 + 
 +==Installing==
 + 
 +Throughout its system, Spotlight identifies files by [http://arstechnica.com/reviews/os/macosx-10.4.ars/11 UTI] types. Because Mac OS X does not have built-in types for OpenOffice.org formatted files, they must be defined by an installed application to avoid having Spotlight assign them dynamically-generated UTI types (which cannot reliably be mapped to a Spotlight importer).
 + 
 +NeoLight assumes the following UTI types correspond to the following file types:
 + 
 +* org.neooffice.writer - Writer "sxw" files and ''stw'' templates
 +* org.neooffice.calc - Calc "sxc" files and ''stc'' templates
 +* org.neooffice.impress - Impress "sxi" files and ''sti'' templates
 +* org.neooffice.draw - Draw "sxd" files and ''std'' templates (hehe)
 +* org.oasis.opendocument.text - OpenDocument Text files "odt" and templates "ott"
 +* org.oasis.opendocument.graphics - OpenDocument Graphics files "odg" and templates "otg"
 +* org.oasis.opendocument.presentation - OpenDocument Presentation files "odp" and templates "otp"
 +* org.oasis.opendocument.spreadsheet - OpenDocument Spreadsheet files "ods" and templates "ots"
 + 
 +The 1.1 plugin release will define these UTI mappings within the Info.plist of the importer plugin. This allows the importer to index OOo formatted documents even on machines that have neither NeoOffice/J nor OpenOffice.org installed!
 + 
 +To install the NeoLight Importer Plugin, simply extract and double-click the '''neolight_installer.pkg.tgz''' file linked to above. After you click through the requisite license agreements, the installer will install the NeoLight plugin named '''neolight.mdimporter''' within the '''/Library/Spotlight''' directory. This will make the NeoLight importer available for all users on the machine.
 + 
 +===Testing Your Installation===
 + 
 +If you have the Tiger Developer's Tools installed, you can verify proper loading of the plugin from a Terminal after installation using the following command:
 + 
 +<pre>/usr/bin/mdimport -L</pre>
 + 
 +You should see '''/Library/Spotlight/neolight.mdimporter''' in the list if all has been installed well.
 + 
 +To verify that installation was successful:
 + 
 +# Launch '''NeoOffice/J'''
 +# Create a new empty Writer document.
 +# Under the '''File''' menu item, choose '''Properties.'''
 +# Add a '''Title''' for the document with a relatively unused nonsense word (e.g. "interzone")
 +# Notice that the title from the '''Properties''' dialog appears in the document's titlebar.
 +# Save the document to a known location with a filename that does not contain your nonsense word.
 +# Start a new Spotlight search.
 +# Type the nonsense word you used above.
 + 
 +If the NeoLight plugin is installed properly, the document you just saved should show up in the search results. If it doesn't, open a Terminal and type the followng:
 + 
 +<pre>/usr/bin/mdimport -d3 /path/to/test/doc.sxw</pre>
 + 
 +Check to make sure the document is of type "org.neooffice.writer". If it is, look in the keys for the "Title" key and you should see your nonsense word. If you do, then everything is installed correctly.
 + 
 +If when you type the above the doc is of type "dyn.a3f42morehexgarbageinherefoo", LaunchServices hasn't mapped the extension to the UTI type properly. Either the update to the '''Info.plist''' is misapplied or you may need to rebuild your LaunchServices database.
 + 
 +If you want to index several files or directories, you can use the "find"-command. This example let Spotlight index all *sxw-files in your $HOME-directory:
 + 
 +<pre>sudo find -s $HOME -name *sxw -exec /usr/bin/mdimport -d3 {} \;</pre>
 + 
 +If you'd like Spotlight to just re-index all of your NeoOffice documents automatically, just use the following command:
 + 
 +<pre>mdimport -r /Library/Spotlight/neolight.mdimporter</pre>
 + 
 +==What does NeoLight Import?==
 + 
 +NeoLight currently handles all four types of major OOo/NeoOffice documents in a single plugin. It will extract the following:
 + 
 +* standard OOo metadata (generally accessible and editable through File > Properties)
 +**title
 +**author/last edited
 +**keywords
 +**description
 +**comments
 +* text content from Writer documents for indexing
 +* textual display content of all cells of a Calc document for indexing
 +* content of bullets, titles, and other text areas for indexing from Impress and Draw documents.
 + 
 +Once the NeoLight plugin is installed, it should be possible to search OOo formatted documents by these criteria within Spotlight enabled applications.
 + 
 +==OpenDocument Compatibility==
 + 
 +Starting with version 1.0.3 (5/7/05), the neolight importer is compatible with both documents generated by NeoOffice/J 0.8.4, NeoOffice/J 1.1, OpenOffice.org 1.x, and OpenOffice.org 2.0 (OpenDocument). While OpenDocument compatibility has not been extensively tested, documents that conform to the approved OpenDocument specification should be compatible.
 + 
 +Version 1.1 (10/2/05) defines UTI types for the OpenDocument o{d,g}* extensions now that the extensions and MIME types have been finalized, so Info.plist editing should no longer be required to start indexing OpenDocument formatted files.
 + 
 +==Using NeoLight to Index OpenOffice.org Documents==
 + 
 +NeoLight is not specific to NeoOffice and can index any OpenOffice.org 1.x formatted document. Starting with version 1.0.3, no special actions are required to index OpenOffice.org documents besides installing the neolight plugin. To force reindexing of OOo documents already existing on your computer, you may need to do a find with mdimport as noted above.
 + 
 +==Known Issues==
 + 
 +* The UTI types are required to be defined before files are manually indexed using mdimport -d3. Files that get indexed prior to the initial installation of the neolight plugin will get the wrong UTI type in the Spotlight metadata database. Although the type tree gets updated to reflect the proper mapping to the org.neooffice types, the raw type remains fixed to the dynamically generated dyn UTI type and the file cannot be indexed. Workaround is to copy the file to a new file and re-index again.
 +* Content is being extracted in Unicode16 encoding, where possible. I am unsure if OOo 1.x files can go to different encodings that may cause the parsers to fail.
 + 
 +==Getting the Source Code==
 + 
 +The source code is in the NeoOffice CVS repository. To checkout the source code do the following:
 + 
 + csh
 + setenv CVSROOT :pserver:anoncvs@anoncvs.neooffice.org:/cvs
 + cvs login
 + 
 +''use '''anoncvs''' as the cvs password''
 + 
 + cvs co neolight
 + 
 +This will checkout the neolight module that has the source code for the plugin. Simply open the neolight.xcodeproj project in Xcode 2.1 or later and away you go!
 + 
 +==Source Code Structure==
 + 
 +In general, the source code is split up into the following files:
 + 
 +* common - These contain utility code used across all the file types and common metadata extraction (all the OpenOffice.org file types have the same meta.xml format)
 +* writer - Contains functions for SXW file parsing.
 +* calc - Contains functions for SXC file parsing.
 +* impress - Contains functions for SXI file parsing (and SXD)
 +* main - CFPlugin foundational code and dispatch of metadata extraction to appropriate handler based on UTI type
 + 
 +All of the functions are commented with [http://docpp.sourceforge.net/ Doc++]/JavaDoc style comments, so you should be able to run a documentation generator on the code to browse through it.
 + 
 +While all of the files are technically Objective-C++, no Cocoa is used in the plugin. It is all CoreFoundation based and I'm essentially using the language as a "better C". Since plugins are supposed to be lightweight, it simply made more sense to re-use the CoreFoundation utilities then to make any grand scheme.
 + 
 +==Issues and Feedback==
 + 
 +Please note any issues here or in the [http://trinity.neooffice.org/modules.php?name=Forums&file=viewforum&f=15 NeoLight Development forum] on http://trinity.neooffice.org
 + 
 +==Binary Changelog==
 + 
 +29.04.2005 ''change install location to /Library/Spotlight''
 + 
 +04.05.2005 ''change from UTF-8 to Unicode; change popen command to use double quotes instead of single''
 + 
 +07.05.2005 ''modify meta.xml parsing for OpenDocument compatibility; add UTI types to plugin's own Info.plist file''
 + 
 +15.05.2005 ''add Apple recommended lsregister command to postflight script of standalone installer''
 + 
 +14.06.2005 ''Fix [http://bugzilla.neooffice.org/bug.php?op=show&bugid=845 bug 845] to index header and footer content''
 + 
 +02.10.2005 ''Universal Binary support; add UTI types for OpenDocument''
 + 
 +[[Category:NeoLight]][[Category:NeoOffice/J]][[Category:OpenOffice.org]][[Category:Release Notes]]

Revision as of 00:52, 9 October 2005

Contents

NeoLight

Edward Peterlin

Authored: 4/29/05

Revised: 10/02/05

What is NeoLight?

NeoLight is an abbreviation I've come up with for "NeoOffice Spotlight Importer". This importer allows Spotlight to index metadata and content within the files created by NeoOffice. Through Spotlight integration, searching across multiple NeoOffice documents can be done in a nice, Mac-like fashion.

Today is the first development release of the NeoLight plugin. This release aims to be the start of an addition that will be included with future builds of NeoOffice/J. The purposes of this release are:

  1. Allow testers who have Tiger to begin assessing the utility of the plugin.
  2. Allow developers access to the source code to bugfix and improve the plugin.
  3. Research what other types of metadata may wish to be extracted from documents.
  4. Get people excited enough to help add support for OpenDocument formatted documents.

Licensing

NeoLight is being released under the GNU Lesser General Public License. While I would have preferred to use a GPL-style license like the main NeoOffice project, LGPL is necessary in this case as the Spotlight importers are shared libraries loaded into closed-source applications. Using LGPL allows for the executable code of NeoLight to be used by Spotlight without "infecting" Mac OS X with GPL requirements.

Installation Requirements

  • Mac OS X 10.4 "Tiger"
  • NeoOffice/J (or OpenOffice.org X11...see below)

Downloading

The NeoLight plugin can be downloaded as a single installer package:

http://trinity.neooffice.org/downloads/neolight_installer.pkg.tgz

  • 40K in size
  • Latest Version : 1.1
  • MD5 sum : 34339a63668f56caadb8dfde6f65223a
  • Last updated 10/2/05 12:29 PST
    • most recent update for OpenDocument support, x86 support

Installing

Throughout its system, Spotlight identifies files by UTI types. Because Mac OS X does not have built-in types for OpenOffice.org formatted files, they must be defined by an installed application to avoid having Spotlight assign them dynamically-generated UTI types (which cannot reliably be mapped to a Spotlight importer).

NeoLight assumes the following UTI types correspond to the following file types:

  • org.neooffice.writer - Writer "sxw" files and stw templates
  • org.neooffice.calc - Calc "sxc" files and stc templates
  • org.neooffice.impress - Impress "sxi" files and sti templates
  • org.neooffice.draw - Draw "sxd" files and std templates (hehe)
  • org.oasis.opendocument.text - OpenDocument Text files "odt" and templates "ott"
  • org.oasis.opendocument.graphics - OpenDocument Graphics files "odg" and templates "otg"
  • org.oasis.opendocument.presentation - OpenDocument Presentation files "odp" and templates "otp"
  • org.oasis.opendocument.spreadsheet - OpenDocument Spreadsheet files "ods" and templates "ots"

The 1.1 plugin release will define these UTI mappings within the Info.plist of the importer plugin. This allows the importer to index OOo formatted documents even on machines that have neither NeoOffice/J nor OpenOffice.org installed!

To install the NeoLight Importer Plugin, simply extract and double-click the neolight_installer.pkg.tgz file linked to above. After you click through the requisite license agreements, the installer will install the NeoLight plugin named neolight.mdimporter within the /Library/Spotlight directory. This will make the NeoLight importer available for all users on the machine.

Testing Your Installation

If you have the Tiger Developer's Tools installed, you can verify proper loading of the plugin from a Terminal after installation using the following command: 

/usr/bin/mdimport -L

You should see /Library/Spotlight/neolight.mdimporter in the list if all has been installed well.

To verify that installation was successful:

  1. Launch NeoOffice/J
  2. Create a new empty Writer document.
  3. Under the File menu item, choose Properties.
  4. Add a Title for the document with a relatively unused nonsense word (e.g. "interzone")
  5. Notice that the title from the Properties dialog appears in the document's titlebar.
  6. Save the document to a known location with a filename that does not contain your nonsense word.
  7. Start a new Spotlight search.
  8. Type the nonsense word you used above.

If the NeoLight plugin is installed properly, the document you just saved should show up in the search results. If it doesn't, open a Terminal and type the followng: 

/usr/bin/mdimport -d3 /path/to/test/doc.sxw

Check to make sure the document is of type "org.neooffice.writer". If it is, look in the keys for the "Title" key and you should see your nonsense word. If you do, then everything is installed correctly.

If when you type the above the doc is of type "dyn.a3f42morehexgarbageinherefoo", LaunchServices hasn't mapped the extension to the UTI type properly. Either the update to the Info.plist is misapplied or you may need to rebuild your LaunchServices database.

If you want to index several files or directories, you can use the "find"-command. This example let Spotlight index all *sxw-files in your $HOME-directory: 

sudo find -s $HOME -name *sxw -exec /usr/bin/mdimport -d3 {} \;

If you'd like Spotlight to just re-index all of your NeoOffice documents automatically, just use the following command: 

mdimport -r /Library/Spotlight/neolight.mdimporter

What does NeoLight Import?

NeoLight currently handles all four types of major OOo/NeoOffice documents in a single plugin. It will extract the following:

  • standard OOo metadata (generally accessible and editable through File > Properties)
    • title
    • author/last edited
    • keywords
    • description
    • comments
  • text content from Writer documents for indexing
  • textual display content of all cells of a Calc document for indexing
  • content of bullets, titles, and other text areas for indexing from Impress and Draw documents.

Once the NeoLight plugin is installed, it should be possible to search OOo formatted documents by these criteria within Spotlight enabled applications.

OpenDocument Compatibility

Starting with version 1.0.3 (5/7/05), the neolight importer is compatible with both documents generated by NeoOffice/J 0.8.4, NeoOffice/J 1.1, OpenOffice.org 1.x, and OpenOffice.org 2.0 (OpenDocument). While OpenDocument compatibility has not been extensively tested, documents that conform to the approved OpenDocument specification should be compatible.

Version 1.1 (10/2/05) defines UTI types for the OpenDocument o{d,g}* extensions now that the extensions and MIME types have been finalized, so Info.plist editing should no longer be required to start indexing OpenDocument formatted files.

Using NeoLight to Index OpenOffice.org Documents

NeoLight is not specific to NeoOffice and can index any OpenOffice.org 1.x formatted document. Starting with version 1.0.3, no special actions are required to index OpenOffice.org documents besides installing the neolight plugin. To force reindexing of OOo documents already existing on your computer, you may need to do a find with mdimport as noted above.

Known Issues

  • The UTI types are required to be defined before files are manually indexed using mdimport -d3. Files that get indexed prior to the initial installation of the neolight plugin will get the wrong UTI type in the Spotlight metadata database. Although the type tree gets updated to reflect the proper mapping to the org.neooffice types, the raw type remains fixed to the dynamically generated dyn UTI type and the file cannot be indexed. Workaround is to copy the file to a new file and re-index again.
  • Content is being extracted in Unicode16 encoding, where possible. I am unsure if OOo 1.x files can go to different encodings that may cause the parsers to fail.

Getting the Source Code

The source code is in the NeoOffice CVS repository. To checkout the source code do the following: 

csh
setenv CVSROOT :pserver:anoncvs@anoncvs.neooffice.org:/cvs
cvs login

use anoncvs as the cvs password 

cvs co neolight

This will checkout the neolight module that has the source code for the plugin. Simply open the neolight.xcodeproj project in Xcode 2.1 or later and away you go!

Source Code Structure

In general, the source code is split up into the following files:

  • common - These contain utility code used across all the file types and common metadata extraction (all the OpenOffice.org file types have the same meta.xml format)
  • writer - Contains functions for SXW file parsing.
  • calc - Contains functions for SXC file parsing.
  • impress - Contains functions for SXI file parsing (and SXD)
  • main - CFPlugin foundational code and dispatch of metadata extraction to appropriate handler based on UTI type

All of the functions are commented with Doc++/JavaDoc style comments, so you should be able to run a documentation generator on the code to browse through it.

While all of the files are technically Objective-C++, no Cocoa is used in the plugin. It is all CoreFoundation based and I'm essentially using the language as a "better C". Since plugins are supposed to be lightweight, it simply made more sense to re-use the CoreFoundation utilities then to make any grand scheme.

Issues and Feedback

Please note any issues here or in the NeoLight Development forum on http://trinity.neooffice.org

Binary Changelog

29.04.2005 change install location to /Library/Spotlight

04.05.2005 change from UTF-8 to Unicode; change popen command to use double quotes instead of single

07.05.2005 modify meta.xml parsing for OpenDocument compatibility; add UTI types to plugin's own Info.plist file

15.05.2005 add Apple recommended lsregister command to postflight script of standalone installer

14.06.2005 Fix bug 845 to index header and footer content

02.10.2005 Universal Binary support; add UTI types for OpenDocument

Retrieved from "https://neowiki.neooffice.org/index.php/NeoLight"
Personal tools