Code Monkey home page Code Monkey logo

publ-wg's Introduction

W3C Logo

This Working Group has been closed on the 20th of June 2023. The maintenance of the WG documents have been taken over by the Publishing Maintenance Working Group.

W3C Audiobooks (formerly Publishing) Working Group

This is the repository for the home page of the W3C Publishing Working Group:

https://www.w3.org/publishing/groups/publ-wg/

(That URL is redirected to the w3c.github.io view of this repository.)

Specifications

GitHub repositories are linked from each specification.

Contributing to the Publishing Working Group Repositories

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.

Tools

Generating weekly minutes is done via the scribejs script and some additional configuration settings provided in this repo (see .scribejs.json).

To use this repository's scribejs setup first install the tools...

$ npm install

Then run the following (with date information changed to match your scenario):

$ npm run scribejs -- -d 2018-07-09 -o Meetings/Minutes/2018/2018-07-09-pwg.md

This will request the IRC logs for the correct channel and convert them into the Kramdown (a more feature rich form of Markdown) with settings to match this repositories other documents.

If you need to make edits to the IRC log before generating the output (due to incorrect scribenick or similar), you can download the W3C logs from URLs such as https://www.w3.org/2018/07/09-pwg-irc.txt. Once downloaded, you can reference that input document directly (rather than using the automagic date-based retrieval).

For example:

$ curl https://www.w3.org/2018/07/09-pwg-irc.txt > 2018-07-09-pwg-irc.txt
$ npm run scribejs -- 2018-07-09-pwg-irc.txt -d 2018-07-09 -o Meetings/Minutes/2018/2018-07-09-pwg.md

Edit the .txt file and repeat the npm run scribejs line as necessary. Once finished, you can commit the .md file and delete the .txt file (or keep it for your records).

publ-wg's People

Contributors

bigbluehat avatar edwinalui82 avatar francofaa avatar geealbers avatar iherman avatar jodischneider avatar koalie avatar mattgarrish avatar rdeltour avatar tzviyasiegman avatar wareid avatar wschindler avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  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  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

publ-wg's Issues

Track AMP related activity and specs

(This issue was originally raised by @BigBlueHat on the wpub issue list, but moved to this repository as part of the more "general" issues.)

AMP is the progenitor of the Web Packaging spec we are being encouraged to consider for PWP. It is also the source of several other specifications that may be of value to our work, and (consequently) we should be involved in these discussions if possible:
https://github.com/ampproject/amphtml/blob/master/contributing/web-standards-related-to-amp.md#overview-of-web-standards-and-features-related-to-amp

Document Collection Interface

Our White Paper talks about the need for an interface and API for a collection of web resources. So really all we have to do is figure this out:

interface Collection: Node {
[SameObject] readonly attribute DOMImplementation implementation;
  readonly attribute USVString URL;
  readonly attribute USVString collectionURI;
  readonly attribute USVString origin;
  readonly attribute DOMString compatMode;
  readonly attribute DOMString characterSet;
  …a few missing details :)
};

Perhaps something like this, more than anything else we are discussing, is what it means for publications to be a first-class citizen of the web.

Google proposed Find in Page API under review by the TAG

(This issue was originally raised by @BigBlueHat on the wpub issue list, but moved to this repository as part of the more "general" issues.)

Review has been requested of the TAG for an API to allow Web apps to provide custom UX in place of the browsers text finding functionality: w3ctag/design-reviews#236

It proposes some events as well as an "extended" set of possible features including loading additional custom results and/or pre-loading not-yet-displayed data so that it can be found by the browsers text finding code.

This differs from the FindText API Working Group Note which focuses on enabling JavaScript-based text searching and Range finding.


WICG discussion that turned into this proposal:
https://discourse.wicg.io/t/allowing-browser-find-in-page-to-find-non-dom-text/1205

scope of "Requirements and design options for synchronized multimedia" is unclear

The "Requirements and design options for synchronized multimedia" doc discusses synchronizing multimedia with "content" but then mentions "book" in the next phrase. Later on it describes a requirement as pertaining to "WP/PWP".

I believe that the ideal scope of synchronized multimedia with overall content (aka text) rendering is all OWP content not just publications. I.e. if we are going to redo and generalize EPUB 3 Media Overlays it should be applicable to web pages not just web publications. So to me the scope of this doc should be clarified as being that general. Of course we could always back off and do something for WP/PWP only but that would seem at odds with the goal of expanding the overall OWP for Publishing. But at a minimum it seems this document should clearly state its scope as that is unclear at the moment.

Navigating a web publication

Readers need to easily navigate through web publications. Such navigation could be complicated by the reality that many web publications consist of many resources, likely in a defined order. EPUB reading systems typically provide UI to access a (required) table of contents from anywhere in the publication, and further provide simple UI gestures to move from document to document.

Should web publications require a comprehensive navigation document? How can we make it easy for users to get from document to document?

Should we use IRI, URI, or URL ?

There is certain level of confusion in the terminology. IRI (ie, rfc3987[1]) is the most general form that encompasses all internationalization requests in IETF land. It is also the reference used in the newest RDF or the Annotation recommendations.

On the other hand, at least for locators, the Web community has always ignored, in practice, the term IRI or URI, and they use URL. See for example, the note to the URL-s in the HTML5 standard[2] that does refer to[1] noting

For the purpose of producing strict URLs one may wish to consider [RFC3986] [RFC3987].

There is also an active work at WhatWG defining URL processing[3] which aims to be interoperable with IRI-s, ie, with RFC3987.

My proposal would be to use URL-s in our terminology, to be also in line with the Web Developer world, but making it clear in the general recommendations that we mean here RFC3987 compatible entities, the same way as HTML5 & Co. do.

  1. https://tools.ietf.org/html/rfc3987
  2. https://www.w3.org/TR/html5/references.html#refsURL
  3. https://url.spec.whatwg.org

Information content of the abstract manifest

What information is required for an abstract manifest? [edited to add items from comments]

  1. An identifier for the web publication, which should be a URL
  2. Some way of saying that this URL represents a web publication.
  3. Some way of identifying the constituent resources of the web publication.
  4. Some way of providing a preferred order of (some of) the constituent resources in case there is more than one
  5. Some way of being able to add more complex metadata to a publication. (Not clear to my mind whether we would define a minimally required set of metadata, but the slot should be there.)
  6. Locating table of contents or other navigation structure

What else? I think we should distinguish required information from "nice to have" information.

Who is responsible for a publication's user interface?

The web is a free-for-all, with design and interaction nearly entirely controlled by the site author.

But ebook reading systems typically control how the user interacts with a publication, and sometimes even change the appearance of publication content.

Will web publications need to provide their own user interface? Will they need to be designed to support both paradigms? What might this mean?

How do we identify a web publication and its components?

A Web Publication (WP) is a collection of one or more constituent resources, organized together in a uniquely identifiable grouping that may be presented using standard Open Web Platform technologies. A Web Publication is not just a collection of links— the act of publishing involves obtaining resources and organizing them into a publication, which must be “manifested” (in the FRBR sense) by having the resources available on a Web server. Thus the publisher provides an origin for the WP, and a URL that can uniquely identify that manifestation.

Perhaps the simplest possible answer to these questions is just a URL: https://www.example.com/MobyDick/ would both identify the publication and mean that everything whose URL starts with this is part of the publication.

So I guess that I’m looking for reasons to make this more complicated :)

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.