[Booki-dev] changes to booki-zip format

Douglas Bagnall douglas at paradise.net.nz
Thu Nov 19 14:37:23 PST 2009


Adam wrote:

(converted to diff)

>  The manifest is a mapping of identifiers to file names and mime-types.
>  Each entry looks like:
>
> -    identifier: [filename, mimetype, authors]
> +    identifier: [filename, mimetype, contributors, rightsHolder, license]


Right.  I see the point here.  Why rightsHolder singular, btw?  By
default, shouldn't all contributors keep copyright?  Can't it grow
with the contributors list? (that's why I didn't distinguish).

>  The constraints on *identifier* match the XML name specification[4]
>  (in short, avoid spaces and most punctuation).  In practise, the
> @@ -103,9 +103,13 @@
>   html files must be of type 'text/html', and other files should be
>   correctly identified.
>
> -*authors* is a list of names of people who have contributed to this
> +*contributors* is a list of names of people who have contributed to this file.  It can be empty.
>
> +*rightsHolder* is the name of the person, group or organisation that manages the rights for the chapter

> +
> +*license* - the copyright license for the chapter. It can contained more than one entry.

> +


Note: a file is not necessarily a chapter.  It might be an image, it
might be a fragment of a chapter, or it might contain several
chapters.

With so much in the manifest, it should probably change to an object
format, like so:

 identifier: {
    "filename": filename,
    "mimetype": mimetype,
    "contributors": contributors,
    "rightsholders": rightsHolders,
    "license": license
}

>  *type* is a string indicating what kind of navigation point it is.
> - This might be used to determine text styles.
> + This might be used to determine text styles. The main Booki TOC types are:

> +- booki-chapter (default)
> +- booki-section
> +- booki-title


The problem here is we're kind of making a promise that these mean
something when they don't.

> @@ -249,12 +262,6 @@

> -      "contributor": {
> -        "": ["Jennifer Redman", "Bart Massey", "Alexander Pico",
> -             "selena deckelmann", "Anne Gentle", "adam hyde", "Olly Betts",

> -             "Jonathan Leto", "Google Inc And The Contributors",
> -             "Leslie Hawthorn"]
> -      },
>        "title": {


I disagree with this.  Why? It just makes everything more complicated
for everybody and eliminates any kind of contribution that isn't
attached to a particular file (like, an anthologist).

> @@ -279,7 +286,14 @@


>
> +Recommended minimum metadata terms are:
> +- language - the primary language of the book
> +- creator - the person or group that primarily created the content (usually 'the author')

> +- title - the title of the book
> +- rightsHolder - the person or organisation managing the rights of the book (usually 'the copyright owner')

> +- license - the copyright license used for the entire book (blank if chapters are variously licensed)


Now, this is terrible! You're forgetting the namespaces.  These ones
are Dublin Core: language, creator, title, contributor, identifier.
RightsHolder and license can go in the DC 'rights' field, and perhaps
can be echoed more formally in the booki namespace.

One last little thing:

> -import into this format.
> +import into this format. Internally Espri manages the conversion of formats into booki-zip.


I'm not sure this belongs in the specification.  Perhaps the whole
paragraph needs to change.

Douglas





More information about the Booki-dev mailing list