meinac/odf_core

The full set of ODF elements and attributes

OdfCore

Full set of "Open Document Format" elements translated into Ruby classes. Ok, seems like cool but what does it mean? It means if you are developing an ODF gem you can take this implementation as a foundation of your gem. If you are looking for an easy to use ODF implementation without knowing all the implementation details of ODF, you are not supposed to be here, instead you can have a look at the ODF gem.

Installation

Add this line to your application's Gemfile:

gem 'odf_core'

And then execute:

$ bundle

Or install it yourself as:

$ gem install odf_core

Usage

This gem provides Ruby classes for all ODF elements. If the element you want to use is draw::text-box then the class you are looking for is OdfCore::Element::Draw::TextBox. The pattern is applicable for all the elements(OdfCore::Element::$NAMESPACE::$ELEMENT_NAME_IN_RUBY_CONVENTION).

The element instance has a simple interface with 3 methods;

• << method allows you to insert child element
• []= method allows you to set attribute for element
• [] method allows you to get the value of the attribute for the element

Example of adding child into an element;

text_box = OdfCore::Element::Draw::TextBox.new
headline = OdfCore::Element::Draw::H.new
text_box << headline

Example of setting and getting the attribute of an element;

text_box = OdfCore::Element::Draw::TextBox.new
text_box['fo:max-height'] = '10px'
text_box['fo:max-height']

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/meinac/odf_core.

License

The gem is available as open source under the terms of the MIT License.