A set of tools to automate publishing of complex documents created in Adobe InDesign into a searchable, responsive, and well-structured website.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bookshow
epub_export
epub_import
.gitignore
LICENSE
README.md

README.md

WebCode Toolkit

Contents of this file

  • Overview
  • Features
  • Installation
  • Configuration options
  • Demo
  • Authors
  • License

Overview

The Los Angeles Department of City Planning is embarking on one of the City’s largest planning initiatives to date: re:code LA, a comprehensive revision of LA’s outdated zoning code. First adopted in 1946, the current Code has grown from a simple, 84-page pamphlet to an unwieldy, 600+ page book that inadequately realizes a 21st Century vision of a better Los Angeles for all residents.

Learn more about the project at http://recode.la/.

One deliverable of this project is a Web-Based Zoning Code, which provides an online and interactive experience to browse, search, and download the new zoning code.

In an effort to contribute key components of this Web-Based Zoning Code project to the open source community, the Los Angeles Department of City Planning has authorized the WebCode Toolkit to be made available to the public.

Features

Epub Export Script

This script automates the process to export the content in the InDesign file as an Epub format.

Epub Import Module

This module allows an Epub file to be uploaded to a Drupal site and have content nodes generated with the text and images content contained within.

Bookshow Module

The bookshow module provides sample display options that integrate with other Drupal contributed modules like Panels and Page Manager.

InDesign Tagging

InDesign allows an editor to include a class to specific tags in the document styles. This is done from the Export Tagging screen on the Character Style and Paragraph Style options menu. Using this, it is possible to send custom metadata about the InDesign document to Drupal.

Installation

The use of the WebCode Toolkit requires both a copy of InDesign and a Drupal website installed. To learn more about these applications please visit the following sites:

Directory structure

bookshow/       = Drupal module
epub_export/    = Location of the InDesign script
epub_import/    = Drupal module

InDesign

To install the InDesign script, place a copy of the EpubExport.jsx file into the Scripts Panel folder inside the InDesign application folder.

Additional information can be found here:

Drupal

To install the Drupal modules, place the module's folder and all of it's contents into the sites/all/modules/ directory of your Drupal installation. Then you need to enable the module on the site's Module Administration page (/admin/modules).

Additional information can be found here:

Importing an Epub File

Once the epub_import module is installed, Epub files can be imported into Drupal from here:

  • /admin/config/content/epub-import

If you have the dashboard module installed, you may also place a block labeled "Epub Import: Import form" on the Dashboard page to import the content into Drupal.

The import form has the following options:

  • Upload file(s): A file upload field that accepts a .epub file.
  • Book: If you have enabled the Book content type, this option lets you select a Book previously created in Drupal to import the content into.
  • Header level: Select the header tag used in your Epub file that will interpreted as node titles in Drupal.
  • Publishing options: This selector lets you decide what to do if duplicate content is discovered (either create new content or replace existing). If you have enabled the bookshow module and selected to replace existing content, you are asked to specify which top level book section you wish to replace.

Configuration options

InDesign Export Tagging

Using InDesign’s own features you can define HTML elements that get included in the Epub file from the character styles. While in the Paragraph or Character Styles window click the Export Tagging menu link to customize the options for "Epub and HTML”.

  • Tag: Select the desired HTML tag to include it with the content in the Epub file.
  • Class: Enter a class name you want included with this particular style.

The following classes are currently supported:

  • ol (used for ordered lists)
  • ul (used for unordered lists)
  • field_* (used for Drupal taxonomy terms; the * is a placeholder for the vocabulary's name)

Epub Import Module

Once enabled, the module offers the following ways to further customize the feature:

  • Import Epub as: Select the content type that should be used when an Epub file is imported.
  • Text format: Select the default Drupal text format for imported text content.
  • Class name prefix: Customize the prefix used for allowed classes in the InDesign Export Settings for Character and Paragraph Styles.
  • Image style: Select the Drupal image style that will be used for imported image content.
  • Images folder: Select the file directory that will be used for imported image content.
  • Header level for each content: Select the InDesign header style that will be used as the break point for each node of content when the Epub file is imported.
  • Taxonomy vocabulary: Select the Drupal taxonomy vocabulary that will be used for imported nodes.

Demo

Coming soon!

Authors

License

Released under the GNU General Public License, version 2 (or higher).

Copyright (c) 2018 City of Los Angeles.