Code Monkey home page Code Monkey logo

lpf's Introduction

W3C Logo

Lightweight Packaging Format

This is the repository of the W3C’s specification on Lightweight Packaging Format, developed by the Audioboks (formerly Publishing) Working Group. The editors’ draft of the specification can also be read directly.

Contributing to the Repository

Use the standard fork, branch, and pull request workflow to propose changes to the specification. Please make branch names informative—by including the issue or bug number for example.

Editorial changes that improve the readability of the spec or correct spelling or grammatical mistakes are welcome.

Please read CONTRIBUTING.md, about licensing contributions.

Code of Conduct

W3C functions under a code of conduct.

lpf's People

Contributors

iherman avatar llemeurfr avatar mattgarrish avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

lpf's Issues

references to wpub

We currently have several references to the wpub spec, especially when we introduce the entry page.

Now that the Publication Manifest goes forward but the Web Publication is "retained", we have to make reference to pub-manifest for publication.json.

I don't see any harm keeping a reference to the wpub note for index.html, as LPF will be a note (if we follow the current consensus), as is wpub.

Any view on this?

Two remaining normative references

There are 2 remaining normative references, even if all sections now have an "informative" class.
They should logically come from the new Conformance section.

explain lightweight

As I mentioned on the call, some explanation of "lightweight" would help to avoid any general confusion. At least as I understand the rationale for it, you might just add a paragraph like the following to start the intro:

"The Lightweight Packaging Format provides a means of packaging digital publication profiles of the Web Publication specification. This format is based on the [OCF] format widely used in publishing to package EPUB publications, but in a more lightweight way - it removes many of the cumbersome rules and restrictions imposed by that format to make packaging and processing simpler."

dom reference?

Where is that informative reference coming from? I don't see anything in the spec.

intro informative

Since we just went through this with pub-manifest, it's probably better to move the terminology out of the intro. The intro paras can then be marked informative.

Replace relative-url strings by relative-url-with-fragment

The spec states "Contents within the Package MUST reference these resources via relative-URL strings [url].".
A relative-URL string cannot contain a fragment identifier.

On the other side the EPUB 3.3 OCF specification states that "Files within the OCF Abstract Container MUST reference each other via relative-URL-with-fragment strings."

See relative-URL-with-fragment strings

We should certainly allow fragment ids in relative URLs. To be validated.

Warning: A relative-URL string can be a path-absolute-URL string. We need to define how path absolute URLs are dereferenced. Same problem as in EPUB 3.3.

Specification section

It is a specification, so having a section 2 called "specification" is redundant. Let the subsections stand on their own.

Naming and scope concern

I am bit concerned by the generic naming of the format. "Lightweight Packaging Format" does not make it clear that it is specifically meant to package Web Publications.
Also the wording in the note that limits the LPF to only package Web Publications is problematic since we will need to package other types of resources as well such as Web Annotations, Synchronized Media etc.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.