BRD: Reader Theme (Atlas Builds)

Revision History

Author/Compiler Description Date
Andrew Odewahn Initial writeup of the HTML theme for the Atlas Reader 5/27/2014
     
     

Business Sponsor and Organization

Andrew Odewahn

Feature Description

The Atlas HTML theme is where we will implement the key user facing features. Themes are combination of visual identity and javascript to make them interactive, so we can support almost any feature that is possible in a web browser.  While we have so far treated themes as a way to apply CSS, there is no reason that a theme could not also be a full fledged application developed in a framework like Ember or Angular.  This seems like the inevitable direction that we must take in order to beyond our current conception of projects as “book on the web” to new forms of interactive content.

Features  include:

  • Visual identity that is consistent with the O’Reilly master brand strategy and the ongoing reconceptualization of oreilly.com
  • Ability to change elements in the CSS (for example, the color of the nave bar) or JavaScript (for example, the name of the Disqus forum or a GA tracking code) by modifying a variable in atlas.json
  • Theming for key HTML elements, such as images, tables, code listings, etc
  • Video player support
  • Social media sharing buttons
  • Google Analytics
  • JSREPL live code samples

One of the goals for the new reboot is to create “engagement.”  Maybe the first step is to figure out how we’d actually measure it so we can design for behaviors we want.  Like, if we say “Engagement is measured by comments” then that’s one thing, but if we say “engagement is time on site” or “engagement is social media discussion” (which will be vastly enabled by a smart preview feature), then that changes the comment discussion completely.

Success Criteria

  • A design that is quickly adopted by editors and authors for their content that is consistent with the O’Reilly master brand strategy
  • An increase in the target metrics identified for the overall oreilly reboot

Maximum Level of Development Effort

This is a large effort.

Areas of Impact

Please X all areas of functionality that will need to be changed to incorporate this feature:

  Visual Editor   Code Editor
  Atlas API x Atlas Workers
x Atlas Reader x CSS Themes
  HTMLBook XSL   Markdown/AsciiDoc parsers
  GitLab   ENTER YOUR OWN HERE