class UCF::File

This class represents a UCF document file - also known as an EPUB and very similar to the EPUB Open Container Format (OCF). See the UCF specification for more details.

This class is a specialization of ZipContainer::File so you should see the ZipContainer documentation for much more information and a list of all the other methods available in this class. RDoc does not list inherited methods, unfortunately.

There are code examples available with the source code of this library.

Public Class Methods

create(filename) → UCF::File click to toggle source

create(filename, mimetype) → UCF::FILE

create(filename) {|file| ...}

create(filename, mimetype) {|file| ...}

Create a new UCF document file on disk and open it for editing. A custom mimetype for the container may be specified but if not the default, “application/epub+zip”, will be used.

Please see the ZipContainer documentation for much more information and a list of all the other methods available in this class. RDoc does not list inherited methods, unfortunately.

Calls superclass method

# File lib/ucf/file.rb, line 78
def self.create(filename, mimetype = DEFAULT_MIMETYPE, &block)
  super(filename, mimetype, &block)
end